You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gr...@apache.org on 2024/03/06 10:05:12 UTC
(logging-log4j2) 02/34: migrated to adoc
This is an automated email from the ASF dual-hosted git repository.
grobmeier pushed a commit to branch ms12_conversion_of_md_files
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 81b1c4205fd4c30cbfe96850443db90891c3dac0
Author: Christian Grobmeier <cg...@grobmeier.de>
AuthorDate: Thu Feb 22 17:02:35 2024 +0100
migrated to adoc
---
.../manual/log4j1-compat.adoc} | 63 ++++++++++++----------
1 file changed, 34 insertions(+), 29 deletions(-)
diff --git a/src/site/markdown/manual/log4j1-compat.md b/src/site/asciidoc/manual/log4j1-compat.adoc
similarity index 70%
rename from src/site/markdown/manual/log4j1-compat.md
rename to src/site/asciidoc/manual/log4j1-compat.adoc
index e6938263b8..549339adc0 100644
--- a/src/site/markdown/manual/log4j1-compat.md
+++ b/src/site/asciidoc/manual/log4j1-compat.adoc
@@ -1,5 +1,7 @@
-<!-- vim: set syn=markdown : -->
-<!--
+////
+vim: set syn=asciidoc :
+////
+////
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
@@ -14,37 +16,38 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
--->
+////
-# Log4j 3 compatibility with Log4j 1
+= Log4j 3 compatibility with Log4j 1
-## API Compatibility
+== API Compatibility
-Log4j 3 provides support for the Log4j 1 logging methods by providing alternate implementations
-of the classes containing those methods. These classes may be found in the log4j-1.2-api jar
+Log4j 3 provides support for the Log4j 1 logging methods by providing alternate implementations
+of the classes containing those methods. These classes may be found in the log4j-1.2-api jar
distributed with the project. All calls to perform logging will result in the data passed to the logging methods
-to be forwarded to the Log4j2 API where they can be processed by implementations of the Log4j 2 API.
+to be forwarded to the Log4j2 API where they can be processed by implementations of the Log4j 2 API.
-## Configuration Compatibility
+== Configuration Compatibility
-Log4j 2 provides experimental support for Log4j 1 configuration files. Configuration of the Appenders, Layouts
-and Filters that were provided in the Log4j 1 distribution will be redirected to their Log4j 2 counterparts -
-with the exception of the implemented Rewrite Policies. This means that although the while the behavior of these
-components will be similar they may not be exactly the same. For example, the XML generated by the XMLLayout may
-not exactly match the XML generated by the Log4j 1XMLLayout.
+Log4j 2 provides experimental support for Log4j 1 configuration files. Configuration of the Appenders, Layouts
+and Filters that were provided in the Log4j 1 distribution will be redirected to their Log4j 2 counterparts -
+with the exception of the implemented Rewrite Policies. This means that although the while the behavior of these
+components will be similar they may not be exactly the same. For example, the XML generated by the XMLLayout may
+not exactly match the XML generated by the Log4j 1XMLLayout.
-In addition, Log4j 2 supports custom Log4j 1 Appenders, Filters, and Layouts with some constraints. Since the
-original Log4j 1 components may not be present in Log4j 2, custom components that extend them will fail.
+In addition, Log4j 2 supports custom Log4j 1 Appenders, Filters, and Layouts with some constraints. Since the
+original Log4j 1 components may not be present in Log4j 2, custom components that extend them will fail.
As support for Log4j 1 is an experimental feature one of the following steps must be taken to enable it:
-1. Set the system property "log4j1.compatibility" to a value of "true". Log4j 2 will then add log4j.properties,
+. Set the system property "log4j1.compatibility" to a value of "true". Log4j 2 will then add log4j.properties,
log4j-test.properties, log4j.xml and log4j-test.xml to the configuration files it searches for on the class path.
-1. Set the Log4j 1 system property "log4j.configuration" to the location of the log4j 1 configuration file. The
+. Set the Log4j 1 system property "log4j.configuration" to the location of the log4j 1 configuration file. The
files must have a file extension of either ".properties" or ".xml".
-## Supported Components
-### Appenders
+== Supported Components
+
+=== Appenders
* AsyncAppender
* ConsoleAppender
@@ -55,14 +58,14 @@ files must have a file extension of either ".properties" or ".xml".
* RollingFileAppender
* SyslogAppender
-## Filters
+== Filters
* DenyAllFilter
* LevelMatchFilter
* LevelRangeFilter
* StringMatchFilter
-## Layouts
+== Layouts
* HtmlLayout
* PatternLayout
@@ -70,23 +73,25 @@ files must have a file extension of either ".properties" or ".xml".
* TTCCLayout
* XmlLayout
-## Rewrite Policies
+== Rewrite Policies
* MapRewritePolicy
* PropertyRewritePolicy
-## Unsupported or Unimplemented Components
-### Appenders
+== Unsupported or Unimplemented Components
+
+=== Appenders
* JDBCAppender (cannot be mapped to Log4j 2's JdbcAppender)
* SocketAppender (Requires the use of the SerializedLayout which is a security risk)
-* SocketHubAppender (Requires the use of the SerializedLayout which is a securiy risk)
+* SocketHubAppender (Requires the use of the SerializedLayout which is a security risk)
* TelnetAppender (Security risk)
-## Rewrite Policies
+== Rewrite Policies
* ReflectionRewritePolicy
* Custom rewrite policies since LoggingEvent is currently a no-op.
-### Renderers
-Log4j 2 currently will ignore renderers.
\ No newline at end of file
+=== Renderers
+
+Log4j 2 currently will ignore renderers.