You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by mi...@apache.org on 2016/04/05 14:03:28 UTC
logging-log4j2 git commit: Update documentation
Repository: logging-log4j2
Updated Branches:
refs/heads/LOG4J2-1356 dce9b623d -> 05e58c6ee
Update documentation
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/05e58c6e
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/05e58c6e
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/05e58c6e
Branch: refs/heads/LOG4J2-1356
Commit: 05e58c6ee4aa4ee9259291a8bb723b79bd0a466d
Parents: dce9b62
Author: Mikael Ståldal <mi...@magine.com>
Authored: Tue Apr 5 14:03:22 2016 +0200
Committer: Mikael Ståldal <mi...@magine.com>
Committed: Tue Apr 5 14:03:22 2016 +0200
----------------------------------------------------------------------
src/site/xdoc/manual/garbagefree.xml | 16 +++++++++++-----
1 file changed, 11 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/05e58c6e/src/site/xdoc/manual/garbagefree.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/manual/garbagefree.xml b/src/site/xdoc/manual/garbagefree.xml
index 7154f38..074f0d0 100644
--- a/src/site/xdoc/manual/garbagefree.xml
+++ b/src/site/xdoc/manual/garbagefree.xml
@@ -102,9 +102,14 @@
<a name="Layouts" />
<subsubsection name="Supported Layouts">
<h4>Supported Layouts</h4>
+
+ <p>
+ <em>Note:</em>Logging Exceptions and stack traces will create temporary objects with any layout.
+ </p>
+
+ <h5>PatternLayout</h5>
<p>
- From the built-in <a href="layouts.html">layouts</a>, currently only PatternLayout
- with the following limited set of conversion patterns is garbage-free.
+ PatternLayout with the following limited set of conversion patterns is garbage-free.
Format modifiers to control such things as field width, padding, left and right justification will not
generate garbage.
</p>
@@ -211,9 +216,6 @@
</tr>
</table>
<p>
- Logging Exceptions and stack traces will create temporary objects.
- </p>
- <p>
Other PatternLayout conversion patterns, and other Layouts may be updated
to avoid creating temporary objects in future releases. (Patches welcome!)
</p>
@@ -232,6 +234,10 @@
</ul>
</td></tr></table>
+
+ <h5>GelfLayout</h5>
+ <p>GelfLayout is garbage-free when used with compressionType="OFF".</p>
+
</subsubsection>
<a name="codeImpact" />
<subsubsection name="Impact on Application Code: Autoboxing">