Skip to content

Commit ffed940

Browse files
ppkarwaszppkarwasz
committed
Fixes property names in release notes (#3089)
Fixes the names of configuration properties introduced after `2.10.0` to always use the normalized form. Fixes #3079
1 parent ebe1758 commit ffed940

19 files changed

+95
-23
lines changed

‎src/changelog/2.10.0/LOG4J2-2091_Log4j_respects_the_configured_log4j2_is_webapp_property.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,9 @@
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="fixed">
66
<issue id="LOG4J2-2091" link="https://issues.apache.org/jira/browse/LOG4J2-2091"/>
7-
<description format="asciidoc">Log4j respects the configured "log4j2.is.webapp" property</description>
7+
<description format="asciidoc">
8+
Log4j respects the configured
9+
xref:manual/systemproperties.adoc#log4j2.isWebapp[`log4j2.isWebapp`]
10+
property.
11+
</description>
812
</entry>

‎src/changelog/2.11.0/LOG4J2-2250_The_internal_status_logger_timestamp_format_is_now_configura.xml

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,8 @@
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="changed">
66
<issue id="LOG4J2-2250" link="https://issues.apache.org/jira/browse/LOG4J2-2250"/>
7-
<description format="asciidoc">The internal status logger timestamp format is now configurable with system property `log4j2.StatusLogger.DateFormat`.</description>
7+
<description format="asciidoc">
8+
The internal status logger timestamp format is now configurable with system property
9+
xref:manual/status-logger.adoc#log4j2.statusLoggerDateFormat[`log4j2.statusLoggerDateFormat`].
10+
</description>
811
</entry>

‎src/changelog/2.15.0/LOG4J2-3160_Fix_documentation_on_how_to_toggle_log4j2_debug_system_prope.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,9 @@
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="fixed">
66
<issue id="LOG4J2-3160" link="https://issues.apache.org/jira/browse/LOG4J2-3160"/>
7-
<description format="asciidoc">Fix documentation on how to toggle log4j2.debug system property.</description>
7+
<description format="asciidoc">
8+
Fix documentation on how to toggle
9+
xref:manual/status-logger.adoc#log4j2.debug[`log4j2.debug`]
10+
system property.
11+
</description>
812
</entry>

‎src/changelog/2.16.0/LOG4J2-3208_Disable_JNDI_by_default_Require_log4j2_enableJndi_to_be_set.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,9 @@
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="fixed">
66
<issue id="LOG4J2-3208" link="https://issues.apache.org/jira/browse/LOG4J2-3208"/>
7-
<description format="asciidoc">Disable JNDI by default. Require log4j2.enableJndi to be set to true to allow JNDI.</description>
7+
<description format="asciidoc">
8+
Disable JNDI by default. Require
9+
xref:manual/systemproperties.adoc#properties-jndi[`log4j2.enableJndi`]
10+
to be set to true to allow JNDI.
11+
</description>
812
</entry>

‎src/changelog/2.17.0/.release-notes.adoc.ftl

+5-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,11 @@ Recursive evaluation is still allowed while generating the configuration.
4545
* The `JndiLookup`, `JndiContextSelector`, and `JMSAppender` now require individual system properties to be enabled.
4646
* Remove LDAP and LDAPS as supported protocols from JNDI.
4747

48-
The single `log4j2.enableJndi` property introduced in Log4j 2.16.0 has been replaced with three individual properties; `log4j2.enableJndiContextSelector`, `log4j2.enableJndiJms`, and `log4j2.enableJndiLookup`.
48+
The single `log4j2.enableJndi` property introduced in Log4j 2.16.0 has been replaced with three individual properties:
49+
xref:manual/systemproperties.adoc#log4j2.enableJndiContextSelector[`log4j2.enableJndiContextSelector`],
50+
xref:manual/systemproperties.adoc#log4j2.enableJndiJms[`log4j2.enableJndiJms`],
51+
and
52+
xref:manual/systemproperties.adoc#log4j2.enableJndiLookup[`log4j2.enableJndiLookup`].
4953

5054
The Log4j 2.17.0 API, as well as many core components, maintains binary compatibility with previous releases.
5155

‎src/changelog/2.17.0/LOG4J2-3242_Limit_JNDI_to_the_java_protocol_only_JNDI_will_remain_disab.xml

+11-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="fixed">
66
<issue id="LOG4J2-3242" link="https://issues.apache.org/jira/browse/LOG4J2-3242"/>
7-
<description format="asciidoc">Limit JNDI to the java protocol only. JNDI will remain disabled by default. Rename JNDI enablement property from
8-
'log4j2.enableJndi' to 'log4j2.enableJndiLookup', 'log4j2.enableJndiJms', and 'log4j2.enableJndiContextSelector'.</description>
7+
<description format="asciidoc">
8+
Limit JNDI to the java protocol only.
9+
JNDI will remain disabled by default.
10+
Rename JNDI enablement property from
11+
xref:manual/systemproperties.adoc#properties-jndi[`log4j2.enableJndi`]
12+
to
13+
xref:manual/systemproperties.adoc#log4j2.enableJndiLookup[`log4j2.enableJndiLookup`],
14+
xref:manual/systemproperties.adoc#log4j2.enableJndiJms[`log4j2.enableJndiJms`],
15+
and
16+
xref:manual/systemproperties.adoc#log4j2.enableJndiContextSelector[`log4j2.enableJndiContextSelector`].
17+
</description>
918
</entry>

‎src/changelog/2.17.1/LOG4J2-3293_JdbcAppender_now_uses_JndiManager_to_access_JNDI_resources.xml

+7-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="fixed">
66
<issue id="LOG4J2-3293" link="https://issues.apache.org/jira/browse/LOG4J2-3293"/>
7-
<description format="asciidoc">JdbcAppender now uses JndiManager to access JNDI resources. JNDI is only enabled when system property
8-
log4j2.enableJndiJdbc is set to true.</description>
7+
<description format="asciidoc">
8+
xref:manual/appenders/database.adoc#JdbcAppender[JDBC Appender]
9+
now uses `JndiManager` to access JNDI resources.
10+
JNDI is only enabled when the system property
11+
xref:manual/systemproperties.adoc#log4j2.enableJndiJdbc[`log4j2.enableJndiJdbc`]
12+
is set to `true`.
13+
</description>
914
</entry>

‎src/changelog/2.17.2/LOG4J2-2486_Require_log4j2_Script_enableLanguages_to_be_specified_to_ena.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,9 @@
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="added">
66
<issue id="LOG4J2-2486" link="https://issues.apache.org/jira/browse/LOG4J2-2486"/>
7-
<description format="asciidoc">Require log4j2.Script.enableLanguages to be specified to enable scripting for specific languages.</description>
7+
<description format="asciidoc">
8+
Require
9+
xref:manual/systemproperties.adoc#log4j2.scriptEnableLanguages[`log4j2.scriptEnableLanguages`]
10+
to be specified to enable scripting for specific languages.
11+
</description>
812
</entry>

‎src/changelog/2.22.0/change_basic_auth_encoding.xml

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
type="changed">
66
<issue id="1970" link="https://github.com/apache/logging-log4j2/pull/1970"/>
77
<description format="asciidoc">
8-
Change default encoding of HTTP Basic Authentication to UTF-8 and add `log4j2.configurationAuthorizationEncoding` property to overwrite it.
8+
Change default encoding of HTTP Basic Authentication to UTF-8 and add
9+
xref:manual/systemproperties.adoc#log4j2.configurationAuthorizationEncoding[`log4j2.configurationAuthorizationEncoding`]
10+
property to overwrite it.
911
</description>
1012
</entry>

‎src/changelog/2.23.1/fix_StatusLogger_instant_formatting.xml

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
type="fixed">
66
<issue id="2322" link="https://github.com/apache/logging-log4j2/pull/2322"/>
77
<description format="asciidoc">
8-
Add `log4j2.StatusLogger.dateFormatZone` system property to set the time-zone `StatusLogger` uses to format `java.time.Instant`.
8+
Add
9+
xref:manual/statusLogger.adoc#log4j2.statusLoggerDateFormatZone[`log4j2.statusLoggerDateFormatZone`]
10+
system property to set the time-zone `StatusLogger` uses to format `java.time.Instant`.
911
Without this, formatting patterns accessing to time-zone-specific fields (e.g., year-of-era) cause failures.
1012
</description>
1113
</entry>

‎src/changelog/2.24.0/.release-notes.adoc.ftl

+3-1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ Please migrate to xref:components.adoc#log4j-mongodb[`log4j-mongodb`] (client ve
5858

5959
=== JMX changes
6060

61-
Starting in version 2.24.0, JMX support is disabled by default and can be re-enabled via the `log4j2.disableJmx=false` system property.
61+
Starting in version 2.24.0, JMX support is disabled by default and can be re-enabled via the
62+
xref:manual/systemproperties.adoc#log4j2.disableJmx[`log4j2.disableJmx`]
63+
system property.
6264

6365
<#include "../.changelog.adoc.ftl">

‎src/changelog/2.24.0/2363_add_logback_throwable_consuming_semantics.xml

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
<issue id="2363" link="https://github.com/apache/logging-log4j2/issues/2363"/>
77
<description format="asciidoc">
88
Add Logback throwable-consuming semantics as an option in `log4j-slf4j-impl` and `log4j-slf4j2-impl`.
9-
Users can enable it by setting the property `log4j2.messageFactory` to `org.apache.logging.slf4j.message.ThrowableConsumingMessageFactory`.
9+
Users can enable it by setting the property
10+
xref:manual/systemproperties.adoc#log4j2.messageFactory[`log4j2.messageFactory`]
11+
to `org.apache.logging.slf4j.message.ThrowableConsumingMessageFactory`.
1012
</description>
1113
</entry>

‎src/changelog/2.24.0/2374_refactor_initialization.xml

+5-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,9 @@
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="changed">
66
<issue id="2374" link="https://github.com/apache/logging-log4j2/pull/2374"/>
7-
<description format="asciidoc">Centralize initialization in the `Provider` class and deprecate `log4j2.loggerContextFactory` property.</description>
7+
<description format="asciidoc">
8+
Centralize initialization in the `Provider` class and deprecate the
9+
xref:manual/systemproperties.adoc#log4j2.loggerContextFactory[`log4j2.loggerContextFactory`]
10+
property.
11+
</description>
812
</entry>

‎src/changelog/2.24.0/2379_fix_message_factory_properties.xml

+8-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
xmlns="https://logging.apache.org/xml/ns"
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="fixed">
6-
<issue id="2505" link="https://github.com/apache/logging-log4j2/pull/2505"/>
7-
<description format="asciidoc">Fix handling of `log4j2.messageFactory` and `log4j2.flowMessageFactory` properties</description>
6+
<issue id="2379" link="https://github.com/apache/logging-log4j2/issues/2379"/>
7+
<description format="asciidoc">
8+
Fix handling of
9+
xref:manual/systemproperties.adoc#log4j2.messageFactory[`log4j2.messageFactory`]
10+
and
11+
xref:manual/systemproperties.adoc#log4j2.flowMessageFactory[`log4j2.flowMessageFactory`]
12+
properties.
13+
</description>
814
</entry>

‎src/changelog/2.24.0/2462_disable_jmx_by_default.xml

+7-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
xmlns="https://logging.apache.org/xml/ns"
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="changed">
6-
<issue id="2462" link="https://github.com/apache/logging-log4j2/issues/2462"/>
7-
<description format="asciidoc">Disable JMX support by default. Require `log4j2.disableJmx` to be set to `false` to enable JMX support.</description>
6+
<issue id="2462" link="https://github.com/apache/logging-log4j2/issues/2462"/>
7+
<description format="asciidoc">
8+
Disable JMX support by default.
9+
Requires
10+
xref:manual/systemproperties.adoc#log4j2.disableJmx[`log4j2.disableJmx`]
11+
to be set to `false` to enable JMX support.
12+
</description>
813
</entry>

‎src/changelog/2.24.0/2703_log4j_debug.xml

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,8 @@
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="fixed">
66
<issue id="2703" link="https://github.com/apache/logging-log4j2/issues/2703"/>
7-
<description format="asciidoc">Fix handling of `log4j2.debug`.</description>
7+
<description format="asciidoc">
8+
Fix handling of
9+
xref:manual/status-logger#log4j2.debug[`log4j2.debug`].
10+
</description>
811
</entry>

‎src/changelog/2.24.0/change-is-webapp.xml

+7-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
type="changed">
66
<issue id="2517" link="https://github.com/apache/logging-log4j2/pull/2517"/>
77
<description format="asciidoc">
8-
Prioritize user-defined values of `log4j2.enableThreadLocals`, `log4j2.garbagefreeThreadContextMap` and `log4j2.shutdownHookEnabled` over the value of `log4j.isWebapp`.
8+
Prioritize user-defined values of
9+
xref:manual/systemproperties.adoc#log4j2.enableThreadlocals[`log4j2.enableThreadlocals`],
10+
xref:manual/systemproperties.adoc#log4j2.garbagefreeThreadContextMap[`log4j2.garbagefreeThreadContextMap`]
11+
and
12+
xref:manual/systemproperties.adoc#log4j2.shutdownHookEnabled[`log4j2.shutdownHookEnabled`]
13+
over the value of
14+
xref:manual/systemproperties.adoc#log4j2.isWebapp[`log4j2.isWebapp`].
915
</description>
1016
</entry>

‎src/changelog/2.24.0/deprecate_log4j2_default_status_level.xml

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,8 @@
44
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
55
type="changed">
66
<issue id="2481" link="https://github.com/apache/logging-log4j2/pull/2481"/>
7-
<description format="asciidoc">Deprecate `log4j2.defaultStatusLevel` property in Log4j Core in favor of `log4j2.statusLoggerLevel`</description>
7+
<description format="asciidoc">
8+
Deprecate `log4j2.defaultStatusLevel` property in Log4j Core in favor of
9+
xref:manual/status-logger.adoc#log4j2.statusLoggerLevel[`log4j2.statusLoggerLevel`].
10+
</description>
811
</entry>

‎src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ If a `log4j2.system.properties` file is available on the classpath its contents
4646
4747
[WARNING]
4848
====
49-
To provide backward compatibility with versions older than 2.10 a certain number of additional property names is also supported using a fuzzy matching algorithm.
49+
To provide backward compatibility with versions older than 2.10.0 a certain number of additional property names are also supported using a fuzzy matching algorithm.
5050
5151
In case of problems with the properties sub-system, make sure that your application does not use property names with the following case-insensitive prefixes:
5252

0 commit comments

Comments
 (0)