svn commit: r1620085 - in /logging/log4j/log4j2/trunk/src: changes/changes.xml site/xdoc/manual/layouts.xml.vm

[gg...@apache.org]

Author: ggregory
Date: Sat Aug 23 21:58:25 2014
New Revision: 1620085

URL: http://svn.apache.org/r1620085
Log:
[LOG4J2-766] Incomplete documentation for JSONLayout.

Modified:
    logging/log4j/log4j2/trunk/src/changes/changes.xml
    logging/log4j/log4j2/trunk/src/site/xdoc/manual/layouts.xml.vm

Modified: logging/log4j/log4j2/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/changes/changes.xml?rev=1620085&r1=1620084&r2=1620085&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/changes/changes.xml (original)
+++ logging/log4j/log4j2/trunk/src/changes/changes.xml Sat Aug 23 21:58:25 2014
@@ -34,6 +34,9 @@
       <action issue="LOG4J2-790" dev="ggregory" type="update">
         Update Jackson to 2.4.2 from 2.4.1 (for XML and JSON processing).
       </action>
+      <action issue="LOG4J2-766" dev="ggregory" type="update" due-to="Bruno P. Kinoshita">
+        Incomplete documentation for JSONLayout.
+      </action>      
     </release> 
     <release version="2.0.2" date="2014-08-16" description="Bug fixes and enhancements">
       <action issue="LOG4J2-775" dev="ggregory" type="update">

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=1620085&r1=1620084&r2=1620085&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 Sat Aug 23 21:58:25 2014
@@ -93,6 +93,45 @@
           <code>compact="true"</code>,  then no end-of-line or indentation is used. Message content may contain,
           of course, escaped end-of-lines.
           </p>
+          <table>
+            <tr>
+              <th>Parameter Name</th>
+              <th>Type</th>
+              <th>Description</th>
+            </tr>
+            <tr>
+              <td>charset</td>
+              <td>String</td>
+              <td>The character set to use when converting the HTML String to a byte array. The value must be
+                a valid <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Charset</a>.
+                If not specified, UTF-8 will be used.</td>
+            </tr>
+            <tr>
+              <td>compact</td>
+              <td>boolean</td>
+              <td>If true, the appender does not use end-of-lines and indentation. Defaults to false.</td>
+            </tr>
+            <tr>
+              <td>complete</td>
+              <td>boolean</td>
+              <td>If true, the appender includes the JSON header and footer. Defaults to false.</td>
+            </tr>
+            <tr>
+              <td>properties</td>
+              <td>boolean</td>
+              <td>If true, the appender includes the thread context in the generated JSON. Defaults to false.</td>
+            </tr>
+            <tr>
+              <td>locationInfo</td>
+              <td>boolean</td>
+              <td>
+              <p>If true, the appender includes the location information in the generated JSON. Defaults to false.</p>
+              <p>Generating <a href="#LocationInformation">location information</a>
+                is an expensive operation and may impact performance. Use with caution.</p>
+              </td>
+            </tr>
+            <caption align="top">JSON Layout Parameters</caption>
+          </table>
         </subsection>
         <a name="HTMLLayout"/>
         <subsection name="HTMLLayout">