[logging-log4j2] 01/13: Fix the `disableAnsi` default value docs (#1537)

[vy...@apache.org]

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

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

commit 017b30d8a25ad7bc588748b19dfe4bc330f277fa
Author: Petr Bodnár <p....@centrum.cz>
AuthorDate: Thu Oct 5 14:03:01 2023 +0200

    Fix the `disableAnsi` default value docs (#1537)
    
    The default value of the disableAnsi parameter (attribute) was changed for Windows
    by https://issues.apache.org/jira/browse/LOG4J2-2087. But the user documentation
    was not updated appropriately.
---
 src/site/xdoc/manual/layouts.xml.vm | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/site/xdoc/manual/layouts.xml.vm b/src/site/xdoc/manual/layouts.xml.vm
index 899997220c..c12b11fef4 100644
--- a/src/site/xdoc/manual/layouts.xml.vm
+++ b/src/site/xdoc/manual/layouts.xml.vm
@@ -805,7 +805,9 @@ WARN  [main]: Message 2</pre>
             <tr>
               <td>disableAnsi</td>
               <td>boolean</td>
-              <td>If <code>true</code> (default is false), do not output ANSI escape codes.</td>
+              <td>If <code>true</code>, do not output ANSI escape codes. Parameter default value is platform dependent.
+                If run on Windows, it defaults to <code>true</code>, unless system property <code>log4j.skipJansi</code>
+                is set to <code>false</code>. On other platforms, it defaults to <code>false</code>.</td>
             </tr>
             <tr>
               <td>noConsoleNoAnsi</td>