Author: rpopma
Date: Wed May 1 01:04:11 2013
New Revision: 1477895
URL: http://svn.apache.org/r1477895
Log:
improved explanation for immediateFlush
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=1477895&r1=1477894&r2=1477895&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml (original)
+++ logging/log4j/log4j2/trunk/src/site/xdoc/manual/appenders.xml Wed May 1
01:04:11 2013
@@ -319,9 +319,15 @@
<tr>
<td>immediateFlush</td>
<td>boolean</td>
- <td>When set to true - the default, each write will be followed
by a flush.
+ <td><p>When set to true - the default, each write will be
followed by a flush.
This will guarantee the data is written
- to disk but could impact performance.</td>
+ to disk but could impact performance.</p>
+ <p>Flushing after every write is only useful when using this
+ appender with synchronous loggers. Asynchronous
loggers and
+ appenders will automatically flush at the end
of a batch of events,
+ even if immediateFlush is set to false. This
also guarantees
+ the data is written to disk but is more
efficient.</p>
+ </td>
</tr>
<tr>
<td>layout</td>
@@ -1068,8 +1074,15 @@
<tr>
<td>immediateFlush</td>
<td>boolean</td>
- <td>When set to true - the default, each write will be followed
by a flush. This will guarantee the data is written
- to disk but could impact performance.</td>
+ <td><p>When set to true - the default, each write will be
followed by a flush.
+ This will guarantee the data is written
+ to disk but could impact performance.</p>
+ <p>Flushing after every write is only useful when using this
+ appender with synchronous loggers. Asynchronous
loggers and
+ appenders will automatically flush at the end
of a batch of events,
+ even if immediateFlush is set to false. This
also guarantees
+ the data is written to disk but is more
efficient.</p>
+ </td>
</tr>
<tr>
<td>layout</td>
@@ -1422,14 +1435,15 @@
<tr>
<td>immediateFlush</td>
<td>boolean</td>
- <td>When set to true - the
default, each write will be followed by a flush.
- This will guarantee the
data is written
- to disk but could
impact performance.
- This option is only
useful when using this
- appender with
synchronous loggers. Asynchronous loggers will
- automatically flush at
the end of a batch, which also guarantees
- the data is written to
disk but is more efficient.
- </td>
+ <td><p>When set to true - the default, each write
will be followed by a flush.
+ This will guarantee the data is written
+ to disk but could impact performance.</p>
+ <p>Flushing after every write is only useful
when using this
+ appender with synchronous
loggers. Asynchronous loggers and
+ appenders will automatically
flush at the end of a batch of events,
+ even if immediateFlush is set
to false. This also guarantees
+ the data is written to disk but
is more efficient.</p>
+ </td>
</tr>
<tr>
<td>layout</td>
@@ -1583,18 +1597,15 @@
<tr>
<td>immediateFlush</td>
<td>boolean</td>
- <td>When set to true - the
default, each write will be followed by a flush. This
- will guarantee the data
is written
- to disk but could impact
- performance.
- This option is only
useful when using this
- appender with
- synchronous loggers.
Asynchronous loggers will
- automatically
- flush at the end of a
batch, which also guarantees
- the data
- is written to disk but
is more efficient.
- </td>
+ <td><p>When set to true - the default, each write
will be followed by a flush.
+ This will guarantee the data is written
+ to disk but could impact performance.</p>
+ <p>Flushing after every write is only useful
when using this
+ appender with synchronous
loggers. Asynchronous loggers and
+ appenders will automatically
flush at the end of a batch of events,
+ even if immediateFlush is set
to false. This also guarantees
+ the data is written to disk but
is more efficient.</p>
+ </td>
</tr>
<tr>
<td>layout</td>
