Document all API changes in log4j-api
#3339
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ppkarwasz
added a commit
that referenced
this pull request
Dec 29, 2024
The Java 9 version of `StackLocator` has an additional public `getCallerClass(String)` method. This method makes the Java 8 and 9 versions of `StackLocator` expose different APIs to the user. To prevent API compatibility problems, we remove the additional method. This incompatibility was accidentally discovered during the work in #3339: `japicmp` did randomly compare a `StackLocator` class from the old version with a `StackLocator` class from the new version. This is part of #1867.
This was referenced Dec 29, 2024
ppkarwasz
commented
Dec 30, 2024
The `entry()/exit()` methods were deprecated in 2.6, when `o.a.l.l.Logger` was annotated with `@Deprecated`. Their `AbstractLogger` implementations became deprecated at the same time.
Internal classes are not used by external artifacts and their Javadoc is not published.
ppkarwasz
added a commit
that referenced
this pull request
Dec 30, 2024
The Java 9 version of `StackLocator` has an additional public `getCallerClass(String)` method. This method makes the Java 8 and 9 versions of `StackLocator` expose different APIs to the user. To prevent API compatibility problems, we remove the additional method. This incompatibility was accidentally discovered during the work in #3339: `japicmp` did randomly compare a `StackLocator` class from the old version with a `StackLocator` class from the new version. This is part of #1867.
ppkarwasz
added a commit
that referenced
this pull request
Dec 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR uses japicmp to compare all 53 stable 2.x releases and document the changes in the public API of the
log4j-apiartifact.The basic invocation of
japicmpis:The resulting report was used to create or fix Javadoc
@sincetags.Part of #1867