[logging-log4j2] branch master updated: LOG4J2-2540 - Minor documentation fixes

[rg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rgoers pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git


The following commit(s) were added to refs/heads/master by this push:
     new 9a13aa4  LOG4J2-2540 - Minor documentation fixes
9a13aa4 is described below

commit 9a13aa4b71a72d19ab0aca061980bbbdf2c6bfc2
Author: Ralph Goers <rg...@apache.org>
AuthorDate: Sun Dec 5 14:48:29 2021 -0700

    LOG4J2-2540 - Minor documentation fixes
---
 src/changes/changes.xml                     |  3 +++
 src/site/asciidoc/manual/architecture.adoc  | 13 ++++++++++---
 src/site/asciidoc/manual/configuration.adoc |  4 ++--
 3 files changed, 15 insertions(+), 5 deletions(-)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 03fd1ad..a7007d2 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -252,6 +252,9 @@
 	based on performance improvements in modern Java releases.
       </action>
       <!-- FIXES -->
+      <action issue="LOG4J2-2540" dev="rgoers">
+        Minor documentation correctsion regarding log levels.
+      </action>
       <action issue="LOG4J2-2541" dev="rgoers" due-to="Gerold Broser">
         Minor documentation corrections in the configuration section.
       </action>
diff --git a/src/site/asciidoc/manual/architecture.adoc b/src/site/asciidoc/manual/architecture.adoc
index f4af1bf..af14611 100644
--- a/src/site/asciidoc/manual/architecture.adoc
+++ b/src/site/asciidoc/manual/architecture.adoc
@@ -164,10 +164,17 @@ process the event.
 
 LoggerConfigs will be assigned a Log
 link:../log4j-api/apidocs/org/apache/logging/log4j/Level.html[`Level`].
-The set of built-in levels includes TRACE, DEBUG, INFO, WARN, ERROR, and
-FATAL. Log4j 2 also supports link:customloglevels.html[custom log
+The set of built-in levels includes ALL, TRACE, DEBUG, INFO, WARN, ERROR,
+FATAL, and OFF. Log4j 2 also supports link:customloglevels.html[custom log
 levels]. Another mechanism for getting more granularity is to use
-link:../log4j-api/api.html#Markers[Markers] instead.
+link:../log4j-api/api.html#Markers[Markers] instead. The OFF and ALL
+levels are not intended to be used on calls to the logging API.
+Specifying OFF in the configuration implies no logging events should
+match while specifying ALL would mean all events match, including custom
+events. However, OFF can be used on logging API calls in special cases
+where the event should always be logged regardless of the configuration.
+However, it is generally recommended that a Marker with a corresponding
+global Marker Filter be used instead.
 
 http://logging.apache.org/log4j/1.2/manual.html[Log4j 1.x] and
 http://logback.qos.ch/manual/architecture.html#effectiveLevel[Logback]
diff --git a/src/site/asciidoc/manual/configuration.adoc b/src/site/asciidoc/manual/configuration.adoc
index 2466510..e4ca035 100644
--- a/src/site/asciidoc/manual/configuration.adoc
+++ b/src/site/asciidoc/manual/configuration.adoc
@@ -605,8 +605,8 @@ java.util.concurrent.TimeUnit)]. (Not used if `shutdownHook` is set to
 
 |status
 |The level of internal Log4j events that should be logged to the console.
-Valid values for this attribute are "trace", "debug", "info", "warn",
-"error" and "fatal". Log4j will log details about initialization,
+Valid values for this attribute are "off", "trace", "debug", "info", "warn",
+"error", "fatal", and "all". Log4j will log details about initialization,
 rollover and other internal actions to the status logger. Setting
 `status="trace"` is one of the first tools available to you if you need
 to troubleshoot log4j.