You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rp...@apache.org on 2014/07/06 14:03:57 UTC

svn commit: r1608193 - in /logging/log4j/log4j2/trunk: log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java src/changes/changes.xml src/site/xdoc/manual/layouts.xml.vm

Author: rpopma
Date: Sun Jul  6 12:03:57 2014
New Revision: 1608193

URL: http://svn.apache.org/r1608193
Log:
LOG4J2-699 fixed PatternLayout manual page: added documentation on header/footer.

Modified:
    logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java
    logging/log4j/log4j2/trunk/src/changes/changes.xml
    logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml.vm

Modified: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java?rev=1608193&r1=1608192&r2=1608193&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java Sun Jul  6 12:03:57 2014
@@ -234,9 +234,9 @@ public final class PatternLayout extends
      * @param noConsoleNoAnsi
      *        If {@code "true"} (default is false) and {@link System#console()} is null, do not output ANSI escape codes
      * @param header
-     *        The footer to place at the end of the document, once.
-     * @param footer
      *        The footer to place at the top of the document, once.
+     * @param footer
+     *        The footer to place at the bottom of the document, once.
      * @return The PatternLayout.
      */
     @PluginFactory

Modified: logging/log4j/log4j2/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/changes/changes.xml?rev=1608193&r1=1608192&r2=1608193&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/changes/changes.xml (original)
+++ logging/log4j/log4j2/trunk/src/changes/changes.xml Sun Jul  6 12:03:57 2014
@@ -22,6 +22,9 @@
   </properties>
   <body>
     <release version="2.0-???" date="2014-0M-DD" description="Bug fixes and enhancements">
+      <action issue="LOG4J2-699" dev="rpopma" type="fix">
+        PatternLayout manual page missing documentation on header/footer.
+      </action>
       <action issue="LOG4J2-625" dev="rpopma" type="fix">
         Fixed Serialization error with SocketAppender and Async Loggers.
         (Fixed in RC2, but wasn't included in release notes.)

Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml.vm
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml.vm?rev=1608193&r1=1608192&r2=1608193&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml.vm (original)
+++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml.vm Sun Jul  6 12:03:57 2014
@@ -207,6 +207,16 @@ WARN  [main]: Message 2</pre>
                 <code>false</code> disables this behavior and allows you to exclude exceptions from your pattern
                 output.</td>
             </tr>
+            <tr>
+              <td>header</td>
+              <td>String</td>
+              <td>The optional header string to include at the top of each log file.</td>
+            </tr>
+            <tr>
+              <td>footer</td>
+              <td>String</td>
+              <td>The optional footer string to include at the bottom of each log file.</td>
+            </tr>
             <caption align="top">PatternLayout Parameters</caption>
           </table>
           <table>