This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/2.x by this push:
new 4c53356bc0 Fix Javadoc inheritDoc tags
4c53356bc0 is described below
commit 4c53356bc08a81d374eca42adcfea67aa5384f1e
Author: Gary Gregory <[email protected]>
AuthorDate: Mon Nov 13 11:30:28 2023 -0500
Fix Javadoc inheritDoc tags
Plus, whatever spotless complained about through through spotless:apply
---
.../src/test/java/org/apache/log4j/LayoutTest.java | 6 +++---
.../java/org/apache/log4j/helpers/DateLayoutTest.java | 8 ++++----
.../org/apache/logging/log4j/core/StringLayout.java | 2 +-
.../db/jdbc/AbstractDriverManagerConnectionSource.java | 2 +-
src/changelog/.2.x.x/fix_javadoc_inheritdoc.xml | 7 +++++++
src/site/_release-notes/_2.0-beta4.adoc | 4 ++--
src/site/_release-notes/_2.14.0.adoc | 2 +-
src/site/_release-notes/_2.14.1.adoc | 18 +++++++++---------
src/site/_release-notes/_2.15.0.adoc | 2 +-
src/site/_release-notes/_2.17.2.adoc | 18 +++++++++---------
src/site/_release-notes/_2.21.0.adoc | 2 +-
src/site/_release-notes/_2.x.x.adoc | 1 +
12 files changed, 40 insertions(+), 32 deletions(-)
diff --git a/log4j-1.2-api/src/test/java/org/apache/log4j/LayoutTest.java
b/log4j-1.2-api/src/test/java/org/apache/log4j/LayoutTest.java
index 87676a070c..09f626e02e 100644
--- a/log4j-1.2-api/src/test/java/org/apache/log4j/LayoutTest.java
+++ b/log4j-1.2-api/src/test/java/org/apache/log4j/LayoutTest.java
@@ -30,20 +30,20 @@ public class LayoutTest extends TestCase {
*/
private static final class MockLayout extends Layout {
/**
- * @{inheritDoc}
+ * {@inheritDoc}
*/
public void activateOptions() {
}
/**
- * @{inheritDoc}
+ * {@inheritDoc}
*/
public String format(final LoggingEvent event) {
return "Mock";
}
/**
- * @{inheritDoc}
+ * {@inheritDoc}
*/
public boolean ignoresThrowable() {
return true;
diff --git
a/log4j-1.2-api/src/test/java/org/apache/log4j/helpers/DateLayoutTest.java
b/log4j-1.2-api/src/test/java/org/apache/log4j/helpers/DateLayoutTest.java
index 46c5bc9825..07b90752d4 100644
--- a/log4j-1.2-api/src/test/java/org/apache/log4j/helpers/DateLayoutTest.java
+++ b/log4j-1.2-api/src/test/java/org/apache/log4j/helpers/DateLayoutTest.java
@@ -54,7 +54,7 @@ public class DateLayoutTest extends LayoutTest {
}
/**
- * @{inheritDoc}
+ * {@inheritDoc}
*/
protected Layout createLayout() {
return new MockLayout();
@@ -264,20 +264,20 @@ public class DateLayoutTest extends LayoutTest {
}
/**
- * @{inheritDoc}
+ * {@inheritDoc}
*/
public String format(final LoggingEvent event) {
return "Mock";
}
/**
- * @{inheritDoc}
+ * {@inheritDoc}
*/
public void activateOptions() {
}
/**
- * @{inheritDoc}
+ * {@inheritDoc}
*/
public boolean ignoresThrowable() {
return true;
diff --git
a/log4j-core/src/main/java/org/apache/logging/log4j/core/StringLayout.java
b/log4j-core/src/main/java/org/apache/logging/log4j/core/StringLayout.java
index fe654ad275..ce6497d90d 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/StringLayout.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/StringLayout.java
@@ -19,7 +19,7 @@ package org.apache.logging.log4j.core;
import java.nio.charset.Charset;
/**
- * Instantiates the @{link Layout} type for String-based layouts.
+ * Instantiates the {@link Layout} type for String-based layouts.
*/
public interface StringLayout extends Layout<String> {
diff --git
a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/jdbc/AbstractDriverManagerConnectionSource.java
b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/jdbc/AbstractDriverManagerConnectionSource.java
index e36f8566d7..48419c0f28 100644
---
a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/jdbc/AbstractDriverManagerConnectionSource.java
+++
b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/jdbc/AbstractDriverManagerConnectionSource.java
@@ -155,7 +155,7 @@ public class AbstractDriverManagerConnectionSource extends
AbstractConnectionSou
} else {
connection = DriverManager.getConnection(actualConnectionString,
toString(userName), toString(password));
}
- LOGGER.debug("{} acquired connection for '{}': {} ({}@{})",
getClass().getSimpleName(), actualConnectionString,
+ LOGGER.debug("{} acquired connection for '{}': {} ({}{@})",
getClass().getSimpleName(), actualConnectionString,
connection, connection.getClass().getName(),
Integer.toHexString(connection.hashCode()));
return connection;
}
diff --git a/src/changelog/.2.x.x/fix_javadoc_inheritdoc.xml
b/src/changelog/.2.x.x/fix_javadoc_inheritdoc.xml
new file mode 100644
index 0000000000..9105d56652
--- /dev/null
+++ b/src/changelog/.2.x.x/fix_javadoc_inheritdoc.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xmlns="http://logging.apache.org/log4j/changelog";
+ xsi:schemaLocation="http://logging.apache.org/log4j/changelog
https://logging.apache.org/log4j/changelog-0.1.2.xsd";
+ type="fixed">
+ <description format="asciidoc">Fix Javadoc inheritDoc tags</description>
+</entry>
diff --git a/src/site/_release-notes/_2.0-beta4.adoc
b/src/site/_release-notes/_2.0-beta4.adoc
index 66f4148b72..ccb794cf06 100644
--- a/src/site/_release-notes/_2.0-beta4.adoc
+++ b/src/site/_release-notes/_2.0-beta4.adoc
@@ -41,10 +41,10 @@ Release date:: 2013-01-28
=== Added
-* Add MessageFormatMessage and FormattedMessage.
* Added Flume Appender samples.
-* Added Log4j 2 to SLF4J adapter.
* Added hostName and contextName to property map.
+* Added Log4j 2 to SLF4J adapter.
+* Add MessageFormatMessage and FormattedMessage.
* Add SMTPAppender.
(https://issues.apache.org/jira/browse/LOG4J2-131[LOG4J2-131])
* Allow custom message creation via a message factory.
(https://issues.apache.org/jira/browse/LOG4J2-133[LOG4J2-133])
* Use %red, %white, %blue, and so on in the console appender.
(https://issues.apache.org/jira/browse/LOG4J2-134[LOG4J2-134])
diff --git a/src/site/_release-notes/_2.14.0.adoc
b/src/site/_release-notes/_2.14.0.adoc
index 9a9a316035..72e0b7ae5a 100644
--- a/src/site/_release-notes/_2.14.0.adoc
+++ b/src/site/_release-notes/_2.14.0.adoc
@@ -67,10 +67,10 @@ For complete information on Apache Log4j 2, including
instructions on how to sub
* Add date pattern support for HTML layout.
(https://issues.apache.org/jira/browse/LOG4J2-2889[LOG4J2-2889])
* Allow GelfLayout to produce newline delimited events.
(https://issues.apache.org/jira/browse/LOG4J2-2892[LOG4J2-2892])
-* Update MongoDB tests to require Java 8 unconditionally now that Log4j
requires Java 8.
* Update com.fasterxml.jackson.* 2.10.2 -> 2.11.0.
* Update jackson 2.11.0 -> 2.11.2.
* Update mongodb3.version from 3.12.1 to 3.12.6.
+* Update MongoDB tests to require Java 8 unconditionally now that Log4j
requires Java 8.
* Update org.apache.activemq:activemq-broker 5.15.11 -> 5.16.0.
* Update org.apache.commons:commons-compress 1.19 -> 1.20.
* Update org.apache.commons:commons-csv 1.7 -> 1.8.
diff --git a/src/site/_release-notes/_2.14.1.adoc
b/src/site/_release-notes/_2.14.1.adoc
index 9d344dfd92..b0dd873f4c 100644
--- a/src/site/_release-notes/_2.14.1.adoc
+++ b/src/site/_release-notes/_2.14.1.adoc
@@ -63,20 +63,17 @@ For complete information on Apache Log4j 2, including
instructions on how to sub
* Allow reconfiguration when Log4j 1 configuration files are updated.
(https://issues.apache.org/jira/browse/LOG4J2-2893[LOG4J2-2893])
* Add Rollover Listener to aid in unit test validation.
(https://issues.apache.org/jira/browse/LOG4J2-2923[LOG4J2-2923])
* Replace outdated PatternLayout.createLayout() calls in docs with
createDefaultLayout().
(https://issues.apache.org/jira/browse/LOG4J2-2977[LOG4J2-2977])
-* Update JSON Unit 2.21.0 -> 2.22.0.
-* Update JaCoCo 0.8.3 -> 0.8.6.
-* Update Mockito 3.6.0 -> 3.7.0.
-* Update MongoDB 3 plugin: org.mongodb:mongodb-driver 3.12.6 -> 3.12.7.
-* Update MongoDB 4 plugin: org.mongodb:* 4.1.0 -> 4.1.1.
-* Update Spring dependencies to 5.3.2, Spring Boot to 2.3.6, and Spring Cloud
to Hoxton.SR9
-* Update Woodstox 5.0.3 -> 6.2.3 to match Jackson 2.12.1.
-* Update XML Unit 2.8.0 -> 2.8.2.
-* Update com.fasterxml.jackson.*:* 2.11.2 - 2.11.3.
* Update commons-codec:commons-codec 1.14 -> 1.15.
* Update commons-io:commons-io 2.7 -> 2.8.0.
+* Update com.fasterxml.jackson.*:* 2.11.2 - 2.11.3.
* Update de.flapdoodle.embed:de.flapdoodle.embed.mongo 2.2.0 -> 3.0.0.
+* Update JaCoCo 0.8.3 -> 0.8.6.
+* Update JSON Unit 2.21.0 -> 2.22.0.
* Update junit:junit 4.13 -> 4.13.1.
+* Update Mockito 3.6.0 -> 3.7.0.
* Update mongodb4.version 4.1.1 -> 4.2.0.
+* Update MongoDB 3 plugin: org.mongodb:mongodb-driver 3.12.6 -> 3.12.7.
+* Update MongoDB 4 plugin: org.mongodb:* 4.1.0 -> 4.1.1.
* Update net.javacrumbs.json-unit:json-unit 1.31.1 -> 2.22.0.
* Update net.javacrumbs.json-unit:json-unit 2.22.0 -> 2.23.0.
* Update org.apache.activemq:* 5.16.0 -> 5.16.1.
@@ -96,6 +93,9 @@ For complete information on Apache Log4j 2, including
instructions on how to sub
* Update org.springframework:* 5.2.8.RELEASE -> 5.3.1.
* Update org.springframework:* 5.3.2 -> 5.3.3.
* Update org.xmlunit:* 2.7.0 -> 2.8.0.
+* Update Spring dependencies to 5.3.2, Spring Boot to 2.3.6, and Spring Cloud
to Hoxton.SR9
+* Update Woodstox 5.0.3 -> 6.2.3 to match Jackson 2.12.1.
+* Update XML Unit 2.8.0 -> 2.8.2.
* - com.fasterxml.jackson.core:jackson-annotations ................. 2.12.1 ->
2.12.2 - com.fasterxml.jackson.core:jackson-core ........................
2.12.1 -> 2.12.2 - com.fasterxml.jackson.core:jackson-databind
.................... 2.12.1 -> 2.12.2 -
com.fasterxml.jackson.dataformat:jackson-dataformat-xml ........ 2.12.1 ->
2.12.2 - com.fasterxml.jackson.dataformat:jackson-dataformat-yaml .......
2.12.1 -> 2.12.2 - com.fasterxml.jackson.module:jackson-module-jaxb-annotations
... 2.1 [...]
=== Fixed
diff --git a/src/site/_release-notes/_2.15.0.adoc
b/src/site/_release-notes/_2.15.0.adoc
index 0f5587d9d4..cdeb3c0b54 100644
--- a/src/site/_release-notes/_2.15.0.adoc
+++ b/src/site/_release-notes/_2.15.0.adoc
@@ -122,8 +122,8 @@ For complete information on Apache Log4j 2, including
instructions on how to sub
* Correct documentation for SyslogAppender when using TLS.
(https://issues.apache.org/jira/browse/LOG4J2-2553[LOG4J2-2553])
* Log4j 1.x properties were not being substituted.
(https://issues.apache.org/jira/browse/LOG4J2-2951[LOG4J2-2951])
* Fix Log Event Level vs Logger Config Level table.
(https://issues.apache.org/jira/browse/LOG4J2-3166[LOG4J2-3166])
-* Update Spring framework to 5.3.13, Spring Boot to 2.5.7, and Spring Cloud to
2020.0.4.
* Updated dependencies. - com.fasterxml.jackson.core:jackson-annotations
................. 2.12.2 -> 2.12.4 - com.fasterxml.jackson.core:jackson-core
........................ 2.12.2 -> 2.12.4 -
com.fasterxml.jackson.core:jackson-databind .................... 2.12.2 ->
2.12.4 - com.fasterxml.jackson.dataformat:jackson-dataformat-xml ........
2.12.2 -> 2.12.4 - com.fasterxml.jackson.dataformat:jackson-dataformat-yaml
....... 2.12.2 -> 2.12.4 - com.fasterxml.jackson.module:jackson-module-ja [...]
+* Update Spring framework to 5.3.13, Spring Boot to 2.5.7, and Spring Cloud to
2020.0.4.
=== Fixed
diff --git a/src/site/_release-notes/_2.17.2.adoc
b/src/site/_release-notes/_2.17.2.adoc
index 7390afd4b3..115b855c31 100644
--- a/src/site/_release-notes/_2.17.2.adoc
+++ b/src/site/_release-notes/_2.17.2.adoc
@@ -79,12 +79,11 @@ For complete information on Apache Log4j 2, including
instructions on how to sub
=== Changed
-* Bump Jackson from 2.12.4 to 2.13.1.
-* Bump Mockito from 3.11.2 to 4.2.0.
-* Bump Woodstox 6.2.6 to 6.2.8.
* Bump awaitility from 4.0.3 to 4.1.1 #663.
* Bump de.flapdoodle.embed:de.flapdoodle.embed.mongo from 3.0.0 to 3.4.1.
Update tests for binary incompatibilities in APIs.
+* Bump Jackson from 2.12.4 to 2.13.1.
* Bump maven-compiler-plugin from 3.8.1 to 3.9.0.
+* Bump Mockito from 3.11.2 to 4.2.0.
* Bump mongodb3.version from 3.12.4 to 3.12.10 #605.
* Bump net.javacrumbs.json-unit:json-unit from 2.27.0 to 2.28.0.
* Bump org.apache.activemq:activemq-broker from 5.16.3 to 5.16.4.
@@ -100,6 +99,7 @@ For complete information on Apache Log4j 2, including
instructions on how to sub
* Bump org.mongodb:mongodb-driver-sync from 4.2.2 to 4.5.0.
* Bump org.springframework:spring-* from 5.3.13 to 5.3.15.
* Bump org.xmlunit:xmlunit-* from 2.8.3 to 2.8.4.
+* Bump Woodstox 6.2.6 to 6.2.8.
* Replace usages of "compile" with "implementation" in the Gradle docs.
(https://issues.apache.org/jira/browse/LOG4J2-3215[LOG4J2-3215])
* Change modifier of method
org.apache.logging.log4j.core.tools.Generate#generate to public (was package
private) to facilitate automated code generation.
(https://issues.apache.org/jira/browse/LOG4J2-3267[LOG4J2-3267])
* log4j-jpl formats message parameters correctly using MessageFormat.
(https://issues.apache.org/jira/browse/LOG4J2-3345[LOG4J2-3345])
@@ -129,10 +129,10 @@ For complete information on Apache Log4j 2, including
instructions on how to sub
* Log4j 1.2 bridge Check for non-existent appender when parsing properties
#761. (https://issues.apache.org/jira/browse/LOG4J2-3407[LOG4J2-3407])
* Log4j 1.2 bridge supports global threshold #764.
(https://issues.apache.org/jira/browse/LOG4J2-3407[LOG4J2-3407])
* Log4j 1.2 bridge throws a ClassCastException when logging a Map with
non-String keys.
(https://issues.apache.org/jira/browse/LOG4J2-3410[LOG4J2-3410])
-* Log4j 1.2 bridge adds org.apache.log4j.Hierarchy.
* Log4j 1.2 bridge adds org.apache.log4j.component.helpers.Constants.
* Log4j 1.2 bridge adds org.apache.log4j.helpers.Loader.
* Log4j 1.2 bridge adds org.apache.log4j.helpers.LogLog.
+* Log4j 1.2 bridge adds org.apache.log4j.Hierarchy.
* Log4j 1.2 bridge adds org.apache.log4j.spi.DefaultRepositorySelector.
* Log4j 1.2 bridge adds org.apache.log4j.spi.NOPLoggerRepository and NOPLogger.
* Log4j 1.2 bridge adds org.apache.log4j.spi.RootLogger.
@@ -146,25 +146,25 @@ For complete information on Apache Log4j 2, including
instructions on how to sub
* Log4j 1.2 bridge creates a SocketAppender instead of a SyslogAppender.
* Log4j 1.2 bridge implements LogManager.getCurrentLoggers() fully.
* Log4j 1.2 bridge implements most of DOMConfigurator.
+* Log4j 1.2 bridge interfaces missing from package org.apache.log4j.spi:
ThrowableRenderer, ThrowableRendererSupport, TriggeringEventEvaluator.
* Log4j 1.2 bridge interface Configurator doConfigure() methods should use
LoggerRepository, not LoggerContext.
* Log4j 1.2 bridge interface org.apache.log4j.spi.RendererSupport was in the
wrong package and incomplete.
-* Log4j 1.2 bridge interfaces missing from package org.apache.log4j.spi:
ThrowableRenderer, ThrowableRendererSupport, TriggeringEventEvaluator.
* Log4j 1.2 bridge issues with filters #753.
-* Log4j 1.2 bridge method Category.exists(String) should be static.
-* Log4j 1.2 bridge method NDC.inherit(Stack) should not use generics to
provide source compatibility.
* Log4j 1.2 bridge methods Category.getChainedPriority() and
getEffectiveLevel() should not be final.
* Log4j 1.2 bridge methods missing in org.apache.log4j.Category:
getDefaultHierarchy(), getHierarchy(), getLoggerRepository().
+* Log4j 1.2 bridge method Category.exists(String) should be static.
+* Log4j 1.2 bridge method NDC.inherit(Stack) should not use generics to
provide source compatibility.
* Log4j 1.2 bridge missed
* Log4j 1.2 bridge missed org.apache.log4j.pattern.FormattingInfo.
* Log4j 1.2 bridge missed org.apache.log4j.pattern.NameAbbreviator.
+* Log4j 1.2 bridge missing class org.apache.log4j.or.RendererMap.
* Log4j 1.2 bridge missing DefaultThrowableRenderer.
* Log4j 1.2 bridge missing FormattingInfo.
* Log4j 1.2 bridge missing PatternConverter.
* Log4j 1.2 bridge missing PatternParser.
-* Log4j 1.2 bridge missing UtilLoggingLevel.
-* Log4j 1.2 bridge missing class org.apache.log4j.or.RendererMap.
* Log4j 1.2 bridge missing some LocationInfo constructors.
* Log4j 1.2 bridge missing some ThrowableInformation constructors.
+* Log4j 1.2 bridge missing UtilLoggingLevel.
* Log4j 1.2 bridge now logs a warning instead of throwing an
NullPointerException when building a Syslog appender with a missing
"SyslogHost" param.
* Log4j 1.2 bridge should allow property and XML attributes to start with
either an upper-case or lower-case letter.
* Log4j 1.2 bridge supports the SocketAppender.
diff --git a/src/site/_release-notes/_2.21.0.adoc
b/src/site/_release-notes/_2.21.0.adoc
index eca7ba5894..f5b3d03bee 100644
--- a/src/site/_release-notes/_2.21.0.adoc
+++ b/src/site/_release-notes/_2.21.0.adoc
@@ -57,8 +57,8 @@ The module name of four bridges (`log4j-slf4j-impl`,
`log4j-slf4j2-impl`, `log4j
* Set the default `minLevel` and `maxLevel` of `LevelRangeFilter` to `OFF` and
`ALL`, respectively (https://github.com/apache/logging-log4j2/pull/1503[1503])
* Removed additional `isFiltered` checks in `AsyncLoggerConfig`
(https://github.com/apache/logging-log4j2/pull/1550[1550])
* Use Java version-specific warnings in `StackLocator`
(https://github.com/apache/logging-log4j2/pull/1760[1760])
-* Started logging a status error event instead of an NPE in
`OsgiServiceLocator.loadServices(Class, Lookup, boolean)` when a bundle has no
valid `BundleContext` for a service type
* Implemented a CI-based release process
+* Started logging a status error event instead of an NPE in
`OsgiServiceLocator.loadServices(Class, Lookup, boolean)` when a bundle has no
valid `BundleContext` for a service type
* Update Eclipse Angus Activation to version
https://github.com/eclipse-ee4j/angus-activation/releases/tag/2.0.1[2.0.1]
(https://github.com/apache/logging-log4j2/issues/1591[1591])
* Update Eclipse Angus Mail to version
https://github.com/eclipse-ee4j/angus-mail/releases/tag/2.0.2[2.0.2]
(https://github.com/apache/logging-log4j2/issues/1591[1591])
* Update `com.datastax.cassandra:cassandra-driver-core` to version 3.11.5
(https://github.com/apache/logging-log4j2/issues/1591[1591])
diff --git a/src/site/_release-notes/_2.x.x.adoc
b/src/site/_release-notes/_2.x.x.adoc
index 4705139fa0..e0c1ba2c65 100644
--- a/src/site/_release-notes/_2.x.x.adoc
+++ b/src/site/_release-notes/_2.x.x.adoc
@@ -74,5 +74,6 @@ The module name of four bridges (`log4j-slf4j-impl`,
`log4j-slf4j2-impl`, `log4j
* Export missing OSGi & JPMS modules in `log4j-layout-template-json` and
`log4j-1.2-api` (https://github.com/apache/logging-log4j2/issues/1895[1895])
* Fix `spring-test` dependency scope change
(https://issues.apache.org/jira/browse/LOG4J2-3675[LOG4J2-3675])
+* Fix Javadoc inheritDoc tags
* Fix JPMS descriptors causing `jlink` issues
(https://github.com/apache/logging-log4j2/issues/1896[1896])
* Add missing `Implementation-` and `Specification-` entries to `MANIFEST.MF`
(implemented by `logging-parent` version `10.3.0` update)
(https://github.com/apache/logging-log4j2/issues/1923[1923])
