logging-log4j2

logging-log4j2 copied to clipboard

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

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

The misspellings have been reported at https://github.com/jsoref/logging-log4j2/commit/6864e281b7898ff3c7d82a57dd72a6ffcc31b228#commitcomment-61673287

The action reports that the changes in this PR would make it happy: https://github.com/jsoref/logging-log4j2/commit/db6552e1def64bc67a3a8141dd06ed0816d9d103

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.

emm

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

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.

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.

I'll review this in more detail later.

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

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

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: https://github.com/jsoref/logging-log4j2/commit/db662e0118a2333d3e73f8cff378e02b692b3fbb#commitcomment-61761571 (and https://github.com/jsoref/logging-log4j2/commit/0e88f32bd42c1e59ca5e35997b7f935c2183a9a2 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.

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.

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

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

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

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

@jsoref,

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

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

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