This is an automated email from the ASF dual-hosted git repository.
rgoers pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/release-2.x by this push:
new 98d106b LOG4J2-2541 - Minor documentation fixes
98d106b is described below
commit 98d106bbd0ba9fd48cad4b8a3b806359131c3099
Author: Ralph Goers <[email protected]>
AuthorDate: Sun Dec 5 14:21:58 2021 -0700
LOG4J2-2541 - Minor documentation fixes
---
src/changes/changes.xml | 3 +++
src/site/xdoc/manual/configuration.xml.vm | 11 +++++++----
2 files changed, 10 insertions(+), 4 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index b33435e..085a5ae 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -116,6 +116,9 @@
Improve PatternLayout performance by reducing unnecessary indirection
and branching.
</action>
<!-- FIXES -->
+ <action issue="LOG4J2-2541" dev="rgoers" due-to="Gerold Broser">
+ Minor documentation corrections in the configuration section.
+ </action>
<action issue="LOG4J2-2553" dev="rgoers">
Correct documentation for SyslogAppender when using TLS.
</action>
diff --git a/src/site/xdoc/manual/configuration.xml.vm
b/src/site/xdoc/manual/configuration.xml.vm
index 11f2940..3d1c826 100644
--- a/src/site/xdoc/manual/configuration.xml.vm
+++ b/src/site/xdoc/manual/configuration.xml.vm
@@ -617,9 +617,12 @@ public class Bar {
</table>
<a name="XML"/><h3>Configuration with XML</h3>
<p>
- Log4j can be configured using two XML flavors; concise and strict.
The concise format makes
- configuration very easy as the element names match the components
they represent however it
- cannot be validated with an XML schema. For example, the
ConsoleAppender is configured by
+ Log4j can be configured using two XML flavors; concise and strict.
+
+ <h5>Concise Syntax</h5>
+
+ The concise format makes configuration very easy as the element
names match the components they represent
+ however it cannot be validated with an XML schema. For example,
the ConsoleAppender is configured by
declaring an XML element named Console under its parent appenders
element. However, element
and attribute names are are not case sensitive. In addition,
attributes can either be specified
as an XML attribute or as an XML element that has no attributes
and has a text value. So
@@ -671,7 +674,7 @@ public class Bar {
In addition to the concise XML format above, Log4j allows
configurations to be specified in a
more "normal" XML manner that can be validated using an XML
Schema. This is accomplished by
replacing the friendly element names above with their object type
as shown below. For example,
- instead of the ConsoleAppender being configuerd using an element
named Console it is instead
+ instead of the ConsoleAppender being configured using an element
named Console it is instead
configured as an appender element with a type attribute containing
"Console".
</p>
<pre class="prettyprint linenums"><