Author: rgrabowski
Date: Sat Aug 23 11:56:17 2008
New Revision: 688397
URL: http://svn.apache.org/viewvc?rev=688397&view=rev
Log:
Fix for LOG4NET-140. Improve documentation for IFixingRequired to explain how
data can be evaluated immediately when a logging event is created or delayed
until being written to an appender.
Modified:
logging/log4net/trunk/src/Core/LoggingEvent.cs
logging/log4net/trunk/xdocs/src/release/manual/contexts.xml
Modified: logging/log4net/trunk/src/Core/LoggingEvent.cs
URL:
http://svn.apache.org/viewvc/logging/log4net/trunk/src/Core/LoggingEvent.cs?rev=688397&r1=688396&r2=688397&view=diff
==============================================================================
--- logging/log4net/trunk/src/Core/LoggingEvent.cs (original)
+++ logging/log4net/trunk/src/Core/LoggingEvent.cs Sat Aug 23 11:56:17 2008
@@ -228,7 +228,7 @@
Exception = 0x100,
/// <summary>
- /// Fix the event properties
+ /// Fix the event properties. Active properties must implement
<see cref="IFixingRequired"/> in order to be eligible for fixing.
/// </summary>
Properties = 0x200,
Modified: logging/log4net/trunk/xdocs/src/release/manual/contexts.xml
URL:
http://svn.apache.org/viewvc/logging/log4net/trunk/xdocs/src/release/manual/contexts.xml?rev=688397&r1=688396&r2=688397&view=diff
==============================================================================
--- logging/log4net/trunk/xdocs/src/release/manual/contexts.xml (original)
+++ logging/log4net/trunk/xdocs/src/release/manual/contexts.xml Sat Aug 23
11:56:17 2008
@@ -149,9 +149,28 @@
string by calling the <span
class="code">ToString</span> method the current number of bytes
allocated by the garbage collector will be returned
and included in the output.
</p>
-
- </section>
-
+ <p>
+ Note that the <span
class="code">ToString</span>method will not be
+ called until the <span
class="code">LoggingEvent</span>is rendered, as
+ explained in the <a
href="#fixing">Fixing</a>section. An active property
+ is not eligible to be fixed
unless it implements
+ <a
href="../sdk/log4net.Core.IFixingRequired.html"> IFixingRequired</a>.
+ </p>
+ </section>
+ </section>
+
+ <section id="fixing" name="Fixing">
+ <p>
+ Some properties, e.g. the current
thread property, or any
+ <a href="#active">active
properties</a>, are not realised
+ until their containing <span
class="code">LoggingEvent</span>is rendered. If the
+ <span
class="code">LoggingEvent</span>is been sent to a buffering appender (such as
+ <a
href="../sdk/log4net.Appender.AdoNetAppender.html">AdoNetAppender</a>) then
this rendering will not happen
+ unless the <a
href="../sdk/log4net.Appender.BufferingAppenderSkeleton.html">
+ BufferingAppenderSkeleton</a>'s <a
href="../sdk/log4net.Appender.BufferingAppenderSkeleton.Fix.html">
+ Fix property</a>has been set. In
addition, an active property is not eligible to be fixed unless it implements
+ <a
href="../sdk/log4net.Core.IFixingRequired.html">IFixingRequired</a>.
+ </p>
</section>
<section id="stacks" name="Context Stacks">
