Author: ggregory
Date: Wed Oct 30 16:26:50 2013
New Revision: 1537162
URL: http://svn.apache.org/r1537162
Log:
Documentation: Use the element names in the descruption of the rolling file
triggering policies.
Modified:
logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml
Modified: logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml
URL:
http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml?rev=1537162&r1=1537161&r2=1537162&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml (original)
+++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml Wed Oct 30
16:26:50 2013
@@ -20,6 +20,7 @@
<properties>
<title>Log4j 2 Appenders</title>
<author email="[email protected]">Ralph Goers</author>
+ <author email="[email protected]">Gary Gregory</author>
<author email="[email protected]">Nick Williams</author>
</properties>
@@ -2237,14 +2238,14 @@ public class JpaLogEntity extends Abstra
<h4>Triggering Policies</h4>
<h5>Composite Triggering Policy</h5>
<p>
- The CompositeTriggeringPolicy combines multiple triggering
policies and returns true if any
- of the configured policies return true. The
CompositeTriggeringPolicy is configured simply
- by wrapping other policies in a "Policies" element.
+ The <code>CompositeTriggeringPolicy</code> combines multiple
triggering policies and returns true if
+ any of the configured policies return true. The
<code>CompositeTriggeringPolicy</code> is configured
+ simply by wrapping other policies in a <code>Policies</code>
element.
</p>
<h5>OnStartup Triggering Policy</h5>
<p>
- The OnStartup policy takes no parameters and causes a rollover
if the log file is older than the
- current JVM's start time.
+ The <code>OnStartupTriggeringPolicy</code> policy takes no
parameters and causes a rollover if the log
+ file is older than the current JVM's start time.
</p>
<p>
<em>Google App Engine note:</em><br />
@@ -2256,14 +2257,15 @@ public class JpaLogEntity extends Abstra
</p>
<h5>SizeBased Triggering Policy</h5>
<p>
- Causes a rollover once the file has reached the specified
size. The size can be specified in bytes,
- KB, MB or GB.
+ The <code>SizeBasedTriggeringPolicy</code> causes a rollover
once the file has reached the specified
+ size. The size can be specified in bytes, with the suffix KB,
MB or GB, for example <code>20MB</code>.
</p>
<h5>TimeBased Triggering Policy</h5>
<p>
- Causes a rollover once the date/time pattern no longer applies
to the active file. This policy
- accepts an "increment" attribute which indicates how
frequently the rollover should occur based on the
- time pattern and a "modulate" boolean attribute.
+ The <code>TimeBasedTriggeringPolicy</code> causes a rollover
once the date/time pattern no longer
+ applies to the active file. This policy accepts an
<code>increment</code> attribute which indicates how
+ frequently the rollover should occur based on the time pattern
and a <code>modulate</code> boolean
+ attribute.
</p>
<table>
<tr>
