You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@logging.apache.org by GitBox <gi...@apache.org> on 2021/12/10 16:30:58 UTC
[GitHub] [logging-log4j2] jsoref commented on a change in pull request #613: Spelling
jsoref commented on a change in pull request #613:
URL: https://github.com/apache/logging-log4j2/pull/613#discussion_r766802175
##########
File path: log4j-core/src/test/java/org/apache/logging/log4j/core/time/internal/format/FastDateParserTest.java
##########
@@ -1,7 +1,7 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
- * this work for additional inparserion regarding copyright ownership.
+ * this work for additional information regarding copyright ownership.
Review comment:
This damaged content is original to the file and is in a license block, which I'd imagine is probably bad form per ASF.
##########
File path: log4j-gctests/src/test/java/org/apache/logging/log4j/gctests/GcFreeMixedSyncAyncLoggingTest.java
##########
@@ -29,7 +29,7 @@
@Tag("allocation")
@Tag("functional")
@Category(GarbageFree.class)
-public class GcFreeMixedSyncAyncLoggingTest {
+public class GcFreeMixedSyncAsyncLoggingTest {
Review comment:
Sigh, java classes require a rename -- I have a script to do that but generally forget to use it since most of the time I'm not touching java projects...
##########
File path: log4j-1.2-api/src/test/resources/config-1.2/hadoop/hadoop-common-project/hadoop-kms/src/test/resources/log4j.properties
##########
@@ -24,7 +24,7 @@ log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %-5p %c{1} - %m%n
log4j.rootLogger=INFO, stdout
log4j.logger.org.apache.hadoop.conf=ERROR
-log4j.logger.org.apache.hadoop.crytpo.key.kms.server=ALL
+log4j.logger.org.apache.hadoop.crypto.key.kms.server=ALL
Review comment:
Google doesn't recognize this string outside here:
https://www.google.com/search?q=%22log4j.logger.org.apache.hadoop.crytpo.key.kms.server%22
##########
File path: log4j-core/README.md
##########
@@ -3,7 +3,7 @@
Log4j 2 supports the Java Platform Module System. JPMS has requirements that conflict with several things
Log4j also tries to support:
1. OSGi - OSGi frameworks are not packaged as OSGi modules. Including an OSGi implementation will cause
-compiler errors while resolving the JPMS module inforation.
+compiler errors while resolving the JPMS module information.
Review comment:
Dev facing readme
##########
File path: src/changes/changes.xml
##########
@@ -156,7 +156,7 @@
Remove deprecated code.
</action>
<action issue="LOG4J2-2545" dev="ckozak" type="fix">
- RoutingAppender.BuilderlsetPurgePolicy fluently returns the builder instance.
+ RoutingAppender.Builder.setPurgePolicy fluently returns the builder instance.
Review comment:
Misleading changelog entries.
Although some projects prefer not to change historical entries in their changelogs, in which case it's trivial for me to drop all changes to this file.
##########
File path: log4j-spring-cloud-config/log4j-spring-cloud-config-client/src/site/markdown/index.md
##########
@@ -42,9 +42,9 @@ When referencing a configuration located in Spring Cloud Config the configuratio
log4j.configurationFile=http://host.docker.internal:8888/ConfigService/sampleapp/default/master/log4j2.xml
```
-Log4j also supports Composite Configurations. The standard way to do that is to concatentate the paths to the files in
+Log4j also supports Composite Configurations. The standard way to do that is to concatenate the paths to the files in
a comma separated string. Unfortunately, Spring validates the URL being provided and commas are not allowed.
-Therefore, additional configurations must be supplied as "override" query parametes.
+Therefore, additional configurations must be supplied as "override" query parameters.
Review comment:
Dev consumer facing documentation
##########
File path: log4j-core/src/main/java/org/apache/logging/log4j/core/util/CronExpression.java
##########
@@ -583,14 +583,14 @@ protected int storeExpressionVals(final int pos, final String s, final int type)
}
if (type != DAY_OF_WEEK && type != DAY_OF_MONTH) {
throw new ParseException(
- "'?' can only be specfied for Day-of-Month or Day-of-Week.",
+ "'?' can only be specified for Day-of-Month or Day-of-Week.",
i);
}
if (type == DAY_OF_WEEK && !lastdayOfMonth) {
final int val = daysOfMonth.last();
if (val == NO_SPEC_INT) {
throw new ParseException(
- "'?' can only be specfied for Day-of-Month -OR- Day-of-Week.",
+ "'?' can only be specified for Day-of-Month -OR- Day-of-Week.",
Review comment:
Dev facing error reporting
##########
File path: log4j-kubernetes/src/site/markdown/index.md.vm
##########
@@ -85,9 +85,9 @@ Note that Spring Boot initializes logging 3 times and only the last will have a
| log4j2.kubernetes.client.connectionTimeout | spring.cloud.kubernetes.client.connectionTimeout | 10s | Connection timeout |
| log4j2.kubernetes.client.httpProxy | spring.cloud.kubernetes.client.http-proxy | | |
| log4j2.kubernetes.client.httpsProxy | spring.cloud.kubernetes.client.https-proxy | | |
-| log4j2.kubernetes.client.loggingInberval | spring.cloud.kubernetes.client.loggingInterval | 20s | Logging interval |
+| log4j2.kubernetes.client.loggingInterval | spring.cloud.kubernetes.client.loggingInterval | 20s | Logging interval |
Review comment:
This is user facing documentation which is actually wrong.
##########
File path: src/site/asciidoc/articles.adoc
##########
@@ -71,7 +71,7 @@ guide for up-to-date and detailed information on how to configure and use Log4j
(January 1, 2020)
* https://www.baeldung.com/log4j2-programmatic-config[Programmatic Configuration with Log4j 2]
(December 31, 2019)
-* https://www.ralphgoers.com/post/log4j-1-compatibility-in-log4j-2[Log4j 1 Compatiblity in Log4j 2]
+* https://www.ralphgoers.com/post/log4j-1-compatibility-in-log4j-2[Log4j 1 Compatibility in Log4j 2]
Review comment:
This link description doesn't match the actual title of the web page.
##########
File path: log4j-api/src/main/java/org/apache/logging/log4j/util/PropertiesUtil.java
##########
@@ -573,7 +573,7 @@ public boolean isOsWindows() {
private enum TimeUnit {
NANOS("ns,nano,nanos,nanosecond,nanoseconds", ChronoUnit.NANOS),
MICROS("us,micro,micros,microsecond,microseconds", ChronoUnit.MICROS),
- MILLIS("ms,milli,millis,millsecond,milliseconds", ChronoUnit.MILLIS),
+ MILLIS("ms,milli,millis,millisecond,milliseconds", ChronoUnit.MILLIS),
Review comment:
This might be an api change, but it probably means that `millisecond` doesn't work
##########
File path: log4j-api/revapi.json
##########
@@ -27,7 +27,7 @@
{
"code": "java.method.removed",
"old": "method void org.apache.logging.log4j.Logger::entry(java.lang.Object[])",
- "justification": "Removed deprectated method"
+ "justification": "Removed deprecated method"
Review comment:
Probably developer facing documentation
##########
File path: log4j-docker/src/site/markdown/index.md.vm
##########
@@ -48,7 +48,7 @@ Attributes may be accessed by adding
```
$D$container
```
-to the configuration. Note that docker variables are only resolved once during logging initializaton so they
+to the configuration. Note that docker variables are only resolved once during logging initialization so they
shouldn't be referenced with more than one '$' character.
Review comment:
Dev consumer facing documentation
##########
File path: src/site/site.xml
##########
@@ -103,7 +103,7 @@
<item name="Scala API" href="/manual/scala-api.html"/>
<item name="Configuration" href="/manual/configuration.html" collapse="true">
- <item name="Configuration Archtecture" href="/manual/configuration.html#Architecture"/>
+ <item name="Configuration Architecture" href="/manual/configuration.html#Architecture"/>
Review comment:
This probably means that the front facing ToC is bad. This makes it harder for users to find things (it's at least screen reader hostile, but also problematic for anyone using search).
##########
File path: src/site/asciidoc/index.adoc
##########
@@ -117,9 +117,9 @@ See link:manual/cloud.html[Logging in the Cloud] for details.
=== Compatible with Log4j 1.x
-The Log4j-1.2-api module of Log4j 2 provides compatiblity for applications using the Log4j 1 logging methods. As
+The Log4j-1.2-api module of Log4j 2 provides compatibility for applications using the Log4j 1 logging methods. As
of Log4j 2.13.0 Log4j 2 also provides experimental support for Log4j 1.x configuration files. See
-link:manual/compatiblity.html[Log4j 2 Compatiblity with Log4j 1] for more information.
+link:manual/compatibility.html[Log4j 2 Compatibility with Log4j 1] for more information.
Review comment:
This developer facing link is bad, as the actual file is: src/site/markdown/manual/compatibility.md
##########
File path: src/site/asciidoc/manual/appenders.adoc
##########
@@ -1270,12 +1270,12 @@ new `<JMS/>` configuration element.
[cols=",,,",options="header",]
|=======================================================================
|Parameter Name |Type |Default |Description
-|allowdLdapClasses|String|null|A comma separated list of fully qualified class names that may be accessed by LDAP.
-The classes must implement Serializable. Only applies when the JMS Appender By default only Java primative classes
+|allowedLdapClasses|String|null|A comma separated list of fully qualified class names that may be accessed by LDAP.
+The classes must implement Serializable. Only applies when the JMS Appender By default only Java primitive classes
are allowed.
-|allowdLdapHosts|String|null|A comma separated list of host names or ip addresses that may be accessed by LDAP.
+|allowedLdapHosts|String|null|A comma separated list of host names or ip addresses that may be accessed by LDAP.
By default only the local host names and ip addresses are allowed.
-|allowdJndiProtocols|String|null|A comma separated list of protocol names that JNDI will allow. By default only java,
+|allowedJndiProtocols|String|null|A comma separated list of protocol names that JNDI will allow. By default only java,
Review comment:
This developer facing documentation is wrong as these fields don't exist in these misspelled forms.
##########
File path: src/site/asciidoc/manual/messages.adoc
##########
@@ -160,7 +160,7 @@ public class MyApp {
public String doUpdate(String table, Map<String, String> params) {
logger.entry(param);
- logger.debug(UPDATE_MARKER, new SQLMessage(SQLMessage.SQLType.UPDATE, table, parmas);
+ logger.debug(UPDATE_MARKER, new SQLMessage(SQLMessage.SQLType.UPDATE, table, params);
Review comment:
This developer facing sample is broken
##########
File path: pom.xml
##########
@@ -1453,7 +1453,7 @@
<exclude>**/*.yml</exclude>
<exclude>**/*.yaml</exclude>
<exclude>**/*.json</exclude>
- <excllude>**/images/*.drawio</excllude>
+ <exclude>**/images/*.drawio</exclude>
Review comment:
build functionally doing the wrong thing?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org