Skip to content

Commit 107e5e2

Browse files
committed
Improve documentation of 2.24.0 bridge changes
1 parent 6049f97 commit 107e5e2

File tree

3 files changed

+27
-14
lines changed

3 files changed

+27
-14
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ The project website has been almost entirely rewritten to provide improved docum
4040

4141
The JUL-to-Log4j API and Log4j 1-to-Log4j API will no longer be able to modify the configuration of Log4j Core by default.
4242
If such a functionality is required, it must be explicitly enabled.
43+
See the documentation of the
44+
xref:migrate-from-log4j1.adoc#log4j1.compatibility[`log4j1.compatibility`]
45+
and
46+
xref:log4j-jul.adoc#log4j2.julLoggerAdapter[`log4j2.julLoggerAdapter`]
47+
configuration properties for more details.
4348

4449
=== Modules
4550

src/site/antora/modules/ROOT/pages/migrate-from-log4j1.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -487,8 +487,8 @@ If an exact backward compatibility is required, you need to <<log4j-1-2-api-inst
487487
[#ConfigurationCompatibility]
488488
=== Use Log4j 1 to Log4j 2 bridge
489489
490-
If you can not convert your configuration files from Log4j 1 to Log4j 2, the Log4j 1 to Log4j 2 bridge can convert your configuration files at runtime.
491-
In order to use this feature you need to <<log4j-1-2-api-installation,Install the Log4j 1 to Log4j 2 bridge>> and set one of the following configuration properties:
490+
If you cannot convert your configuration files from Log4j 1 to Log4j 2, the Log4j 1 to Log4j 2 bridge can convert your configuration files at runtime.
491+
To use this feature, you need to <<log4j-1-2-api-installation,Install the Log4j 1 to Log4j 2 bridge>> and set one of the following configuration properties:
492492
493493
include::partial$manual/systemproperties/properties-log4j-12-api.adoc[leveloffset=+2]
494494
@@ -540,13 +540,17 @@ xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-1-2-api_org-apache-log
540540
[#option-1-use-the-log4j-1-x-bridge-log4j-1-2-api]
541541
== [[Log4j12Bridge]]Log4j 1 to Log4j 2 bridge
542542
543-
In order to help users with the migration process, a Log4j 1 to Log4j 2 bridge is available.
544-
The bridge can fulfill three separate functions:
545-
546-
* it forwards all <<log4j-1-api-methods,Log4j 1 API>> method calls to the corresponding Log4j 2 API calls,
547-
* since version 2.17.2 is supports the usage of some components written for Log4j 1 inside Log4j 2 Core,
548-
* it provides a limited support for programmatic configuration of Log4j 2 Core, using Log4j 1 method calls,
549-
* it provides a limited support for Log4j 1 configuration file formats.
543+
To help users with the migration process, a Log4j 1 to Log4j 2 bridge is available.
544+
The bridge can fulfill four separate functions:
545+
546+
* It forwards all <<log4j-1-api-methods,Log4j 1 API>> method calls to the Log4j 2 API.
547+
See <<api-use-bridge,how to use the bridge for Log4j 1 API migration>> for more details.
548+
* Since version 2.17.2 the bridge supports the usage of some components written for Log4j 1 inside Log4j 2 Core.
549+
See <<migrate-custom-components,how to use the bridge for Log4j 1 Backend migration>> for more details.
550+
* It provides limited support for programmatic configuration of Log4j 2 Core, using Log4j 1 method calls.
551+
This functionality requires the <<log4j1.compatibility,`log4j1.compatibility` configuration property>> to be set to `true`.
552+
* It provides a limited support for Log4j 1 configuration file formats.
553+
See <<ConfigurationCompatibility,how to use the bridge for Log4j 1 Configuration file migration>> for more details.
550554
551555
[#log4j-1-2-api-installation]
552556
=== Installation

src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-12-api.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,16 @@
2424
| Default value | `false`
2525
|===
2626
27-
If set to `true`, Log4j 2 will scan the classpath to find Log4j 1 configuration files in the following standard locations:
27+
If set to `true`, Log4j 2 will:
2828
29-
* `log4j-test.properties`,
30-
* `log4j-test.xml`,
31-
* `log4j.properties`,
32-
* `log4j.xml`.
29+
* Scan the classpath to find Log4j 1 configuration files in the following standard locations:
30+
31+
** `log4j-test.properties`,
32+
** `log4j-test.xml`,
33+
** `log4j.properties`,
34+
** `log4j.xml`.
35+
36+
* (since `2.24.0`) Enable the usage of the `o.a.log4j.PropertyConfigurator` and `o.a.log4j.xml.DOMConfigurator` classes in your code.
3337
3438
[id=log4j.configuration]
3539
== `log4j.configuration`

0 commit comments

Comments
 (0)