Spelling #613

jsoref · 2021-12-10T06:02:25Z

https://issues.apache.org/jira/browse/LOG4J2-3203

This PR corrects misspellings identified by the check-spelling action.

The misspellings have been reported at jsoref@6864e28#commitcomment-61673287

The action reports that the changes in this PR would make it happy: jsoref@db6552e

Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately.

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

zuoshangs · 2021-12-10T06:11:22Z

emm

vy · 2021-12-10T15:32:12Z

@jsoref, even though we appreciate your contribution for code clean-ups, it is quite time consuming for us to review every single line, in particular, given your changes span across hundreds of files and thousands of lines. Time is a pretty scarce resource among Log4j maintainers and we rather spend that on higher priority issues, e.g., bug triages & fixes, (killer?) features, etc.

It would be a pity to get you discouraged from contributing, yet, we think such bulk code clean-ups are better done by committers without needing the attention of another developer. That said, we will be more than happy to see you participating in more functional Log4j stories. Would you consider either improving the documentation and/or picking up open Jira issues? This might also make your way to becoming a committer, where you can freely go wild with your code clean-ups.

jsoref · 2021-12-10T15:44:39Z

I'm not currently a log4j2 user.

We happen to be using log4j, so, in theory, I have some potential interest in this project as opposed to just offering a general contribution to a project I've heard of – which I do regularly.

I personally tend to check the health of a project by sending a change like this. (That you responded in under a day puts you into the healthy side by one of my measures.)

I'm quite happy to respond to review comments, e.g. "only this directory", or "only comments", or "only code", or "drop these directories", or "squash".

In a past life, I did a lot of bug triage. I don't have a particular interest to do that in my spare time. I do appreciate your offer and attempts to grow your community.

Fwiw, I am an ASF contributor and an working on getting similar changes merged into other ASF projects. I'm also very patient, it doesn't matter to me if it takes a year to integrate changes – since I can do other work elsewhere in the interim.

jvz · 2021-12-10T16:20:18Z

Josh, long time no see! It'd be awesome if you could either break up changes or leave PR comments on relevant areas to help with review.

jsoref

I generally do leave an annotation of the interesting bits.

I've skipped commenting on local variable renames as they're generally uninteresting. Similarly, I've skipped most comment changes.

Happy to split.

jsoref · 2021-12-10T16:10:34Z

...ore/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.


This damaged content is original to the file and is in a license block, which I'd imagine is probably bad form per ASF.

jsoref · 2021-12-10T16:11:43Z

...j-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 {


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...

jsoref · 2021-12-10T16:12:30Z

log4j-kubernetes/src/site/markdown/index.md.vm

-| log4j2.kubernetes.client.loggingInberval | spring.cloud.kubernetes.client.loggingInterval | 20s | Logging interval |
+| log4j2.kubernetes.client.loggingInterval | spring.cloud.kubernetes.client.loggingInterval | 20s | Logging interval |


This is user facing documentation which is actually wrong.

jsoref · 2021-12-10T16:15:03Z

...urces/config-1.2/hadoop/hadoop-common-project/hadoop-kms/src/test/resources/log4j.properties

-log4j.logger.org.apache.hadoop.crytpo.key.kms.server=ALL
+log4j.logger.org.apache.hadoop.crypto.key.kms.server=ALL


Google doesn't recognize this string outside here:
https://www.google.com/search?q=%22log4j.logger.org.apache.hadoop.crytpo.key.kms.server%22

jsoref · 2021-12-10T16:15:17Z

log4j-api/revapi.json

-        "justification": "Removed deprectated method"
+        "justification": "Removed deprecated method"


Probably developer facing documentation

jsoref · 2021-12-10T16:24:51Z

src/site/asciidoc/articles.adoc

-* 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]


This link description doesn't match the actual title of the web page.

jsoref · 2021-12-10T16:25:47Z

src/site/asciidoc/index.adoc

-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.


This developer facing link is bad, as the actual file is: src/site/markdown/manual/compatibility.md

jsoref · 2021-12-10T16:26:20Z

src/site/asciidoc/manual/appenders.adoc

-|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,


This developer facing documentation is wrong as these fields don't exist in these misspelled forms.

Normally my tooling doesn't merge commits together, but this probably happened because of a merge conflict when I sorted my commits. Sorry about that.

jsoref · 2021-12-10T16:27:24Z

src/site/asciidoc/manual/messages.adoc

    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);


This developer facing sample is broken

jsoref · 2021-12-10T16:29:17Z

src/site/site.xml

-        <item name="Configuration Archtecture" href="/manual/configuration.html#Architecture"/>
+        <item name="Configuration Architecture" href="/manual/configuration.html#Architecture"/>


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).

jvz · 2021-12-10T17:39:21Z

I'll review this in more detail later.

pjfanning · 2021-12-10T19:07:10Z

One typo that I noticed earlier was 'primative' appearing in a few places in one of the PRs related to the recent CVE issue. (https://github.com/apache/logging-log4j2/pull/608/files) -- since a lot of people will be reading these changes in particular, this typo would be a good one to start with - I can do a PR for just this one if people think that is a good idea

rgoers · 2021-12-12T03:19:32Z

@pjfanning That is one of my favorite words to misspell. :-)

jsoref · 2021-12-12T03:27:34Z

I don't care about credit. I make PRs to improve codebases. Feel free to cherry-pick whichever pieces/ideas you like (or reimplement).

I've also made a corresponding set of changes for release-2.x: https://github.com/jsoref/logging-log4j2/commits/spelling-2.x
As with this PR, the list of typos addressed is available: jsoref@db662e0#commitcomment-61761571 (and jsoref@0e88f32 shows the spell-checker isn't unhappy).

I'm quite willing to make a subset of changes. The easiest thing would be to drop changes to .java files (and a couple of changes that relate to them). I think overall that the non .java files tend to be developer/user facing.

ppkarwasz · 2023-03-01T07:04:44Z

This was closed automatically by Github because we renamed the release-2.x branch to 2.x. Feel free to resubmit to the 2.x branch.

jsoref · 2023-03-01T07:17:47Z

I'm working on it, but your linters and I do not get along.

ppkarwasz · 2023-03-01T07:21:06Z

Spotless can correct formatting violation: run mvn spotless:apply.

Formatting checks bother everybody, but it beats conflicts caused by whitespace differences.

jsoref · 2023-03-01T07:23:07Z

[ERROR] No plugin found for prefix 'spotless' in the current project and in the plugin groups [org.apache.maven.plugins, org.codehaus.mojo] available from the repositories [local (/Users/jsoref/.m2/repository), apache.snapshots (https://repository.apache.org/snapshots), central (https://repo.maven.apache.org/maven2)] -> [Help 1]

ppkarwasz · 2023-03-01T08:16:40Z

@jsoref,

There is a module without spotless (log4j-bom). If you exclude it, everything should work.

jsoref · 2023-03-01T13:04:42Z

That's unhelpful. Please provide a full incantation instead of a random hint.

ppkarwasz · 2023-03-01T13:21:15Z

@jsoref: in bash you run mvn spotless:apply -pl \!log4j-bom. Other shells have different ways to escape !.

jsoref added 30 commits December 9, 2021 23:33

spelling: affected

9cefde7

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: aggregator

59409b2

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: allowed

98f6006

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: annotations

d876082

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: appender

ece2509

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: approximate

8482a0e

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: arbiter

a05b430

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: architecture

dd7317d

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: async

7a7cab9

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: attribute

f1dc53b

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: authorization

40f606f

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: available

cee0f62

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: based

4c8d436

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: behaviour

0d2b66a

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: builder.set

849d028

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: builders

2a0e9b3

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: capabilities

5c6c1ad

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: characters

7e960aa

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: collection

9240a9e

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: common

62146ce

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: compatibility

05febda

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: compilation

634f5be

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: concatenate

3f668a2

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: configuration

74585c8

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: configurations

0144e2c

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: connect

4c9db39

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: contains

ce7a342

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: converts

48a322d

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: correction

dc0d6b2

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: counting

9336637

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

jsoref added 8 commits December 10, 2021 00:48

spelling: synchronizers

e34ba2b

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: throughout

8ea94ba

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: timestamp

a0f2245

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: trimmed

f5149b1

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: unknown

4d2679c

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: utilities

728e6be

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: waiting

5931622

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

spelling: watchers

47dbc5d

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

vy closed this Dec 10, 2021

jsoref commented Dec 10, 2021

View reviewed changes

jvz reopened this Dec 10, 2021

ThomasVerhoeven1998 approved these changes Dec 13, 2021

View reviewed changes

vy deleted the branch apache:master February 28, 2023 15:02

vy closed this Feb 28, 2023

jsoref mentioned this pull request Nov 24, 2023

Spotless failures should generate artifacts #1319

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Spelling #613

Spelling #613

jsoref commented Dec 10, 2021

zuoshangs commented Dec 10, 2021

vy commented Dec 10, 2021

jsoref commented Dec 10, 2021

jvz commented Dec 10, 2021

jsoref left a comment

jsoref Dec 10, 2021

jsoref Dec 10, 2021

jsoref Dec 10, 2021

jsoref Dec 10, 2021

jsoref Dec 10, 2021

jsoref Dec 10, 2021

jsoref Dec 10, 2021

jsoref Dec 10, 2021

jsoref Dec 11, 2021

jsoref Dec 10, 2021

jsoref Dec 10, 2021

jvz commented Dec 10, 2021

pjfanning commented Dec 10, 2021

rgoers commented Dec 12, 2021

jsoref commented Dec 12, 2021

ppkarwasz commented Mar 1, 2023

jsoref commented Mar 1, 2023

ppkarwasz commented Mar 1, 2023

jsoref commented Mar 1, 2023

ppkarwasz commented Mar 1, 2023

jsoref commented Mar 1, 2023

ppkarwasz commented Mar 1, 2023

		\| log4j2.kubernetes.client.loggingInberval \| spring.cloud.kubernetes.client.loggingInterval \| 20s \| Logging interval \|
		\| log4j2.kubernetes.client.loggingInterval \| spring.cloud.kubernetes.client.loggingInterval \| 20s \| Logging interval \|

		log4j.logger.org.apache.hadoop.crytpo.key.kms.server=ALL
		log4j.logger.org.apache.hadoop.crypto.key.kms.server=ALL

		"justification": "Removed deprectated method"
		"justification": "Removed deprecated method"

		* 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]

		<item name="Configuration Archtecture" href="/manual/configuration.html#Architecture"/>
		<item name="Configuration Architecture" href="/manual/configuration.html#Architecture"/>

Spelling #613

Spelling #613

Conversation

jsoref commented Dec 10, 2021

zuoshangs commented Dec 10, 2021

vy commented Dec 10, 2021

jsoref commented Dec 10, 2021

jvz commented Dec 10, 2021

jsoref left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jvz commented Dec 10, 2021

pjfanning commented Dec 10, 2021

rgoers commented Dec 12, 2021

jsoref commented Dec 12, 2021

ppkarwasz commented Mar 1, 2023

jsoref commented Mar 1, 2023

ppkarwasz commented Mar 1, 2023

jsoref commented Mar 1, 2023

ppkarwasz commented Mar 1, 2023

jsoref commented Mar 1, 2023

ppkarwasz commented Mar 1, 2023