logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ihabu...@apache.org
Subject svn commit: r1214166 - in /logging/log4php/trunk/src/site/xdoc/docs: ./ appenders/
Date Wed, 14 Dec 2011 11:24:07 GMT
Author: ihabunek
Date: Wed Dec 14 11:24:06 2011
New Revision: 1214166

URL: http://svn.apache.org/viewvc?rev=1214166&view=rev
Log:
Documented default layout behaviour for appenders.

Modified:
    logging/log4php/trunk/src/site/xdoc/docs/appenders.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/console.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/daily-file.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/echo.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/file.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/mail-event.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/mail.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/mongodb.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/null.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/pdo.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/php.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/rolling-file.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/socket.xml
    logging/log4php/trunk/src/site/xdoc/docs/appenders/syslog.xml

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders.xml Wed Dec 14 11:24:06 2011
@@ -124,7 +124,8 @@
 					<li>A <strong>class</strong> which specifies which appender class
will be used to handle the 
 					requests. Since we wish to log to a file, <code>LoggerAppenderFile</code>
is used in this case.</li>
 					<li>A <strong>layout</strong> which transforms the logging events
to string which can be logged.
-					A layout is required by most appenders, but some do not require it, such as the database
appender.</li>
+					A layout is required by most appenders, but some do not require it, such as the database
appender. 
+					If a layout is not defined, the appenders will use a default layout.</li>
 					<li>Zero or more <strong>parameters</strong> which configure the appender

 					behaviour. In this example, the <em>file</em> parameter governs the path
to the file which will be
 					used for logging, and <em>append</em> defines that log messages should be
appended to the file,

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/console.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/console.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/console.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/console.xml Wed Dec 14 11:24:06 2011
@@ -28,6 +28,11 @@
 			<p><code>LoggerAppenderConsole</code> writes logging events to the <code>php://stdout</code>
or 
 			the <code>php://stderr</code> stream, the former being the default target.</p>
 			
+			<subsection name="Layout">
+				<p>This appender requires a layout. If no layout is specified in configuration,

+				<code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code>
will be used by default.</p>
+			</subsection>
+
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>
 		

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/daily-file.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/daily-file.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/daily-file.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/daily-file.xml Wed Dec 14 11:24:06
2011
@@ -32,6 +32,11 @@
 			which will be substituted with the current date when logging. The <code>datePattern</code>
parameter 
 			determines how the date will be formatted.</p>
 			
+			<subsection name="Layout">
+				<p>This appender requires a layout. If no layout is specified in configuration,

+				<code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code>
will be used by default.</p>
+			</subsection>
+			
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>
 		

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/echo.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/echo.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/echo.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/echo.xml Wed Dec 14 11:24:06 2011
@@ -29,6 +29,11 @@
 			<code><a class="externalLink" target="_blank" href="http://php.net/manual/en/function.echo.php">echo()</a>
 			</code> function. Echo outputs may be buffered.</p>
 		
+			<subsection name="Layout">
+				<p>This appender requires a layout. If no layout is specified in configuration,

+				<code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code>
will be used by default.</p>
+			</subsection>
+		
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>
 		

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/file.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/file.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/file.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/file.xml Wed Dec 14 11:24:06 2011
@@ -27,6 +27,11 @@
 		
 			<p><code>LoggerAppenderFile</code> writes logging events to a file.</p>
 		
+			<subsection name="Layout">
+				<p>This appender requires a layout. If no layout is specified in configuration,

+				<code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code>
will be used by default.</p>
+			</subsection>
+			
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>
 		

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/mail-event.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/mail-event.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/mail-event.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/mail-event.xml Wed Dec 14 11:24:06
2011
@@ -30,6 +30,11 @@
 			<p>This appender is similar to <code><a href="mail.html">LoggerAppenderMail</a></code>,
except that it 
   			sends each each log event in an individual email message at the time when it occurs.</p>
 			
+			<subsection name="Layout">
+				<p>This appender requires a layout. If no layout is specified in configuration,

+				<code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code>
will be used by default.</p>
+			</subsection>
+			
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>
 		

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/mail.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/mail.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/mail.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/mail.xml Wed Dec 14 11:24:06 2011
@@ -35,6 +35,11 @@
 			<p class="alert-message warning">When working in Windows, make sure that the <code>SMTP</code>
and <code>smpt_port</code>
 			values in php.ini are set to the correct values for your email server (address and port).</p>
 			
+			<subsection name="Layout">
+				<p>This appender requires a layout. If no layout is specified in configuration,

+				<code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code>
will be used by default.</p>
+			</subsection>
+			
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>
 		

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/mongodb.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/mongodb.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/mongodb.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/mongodb.xml Wed Dec 14 11:24:06 2011
@@ -30,6 +30,10 @@
 			<p><a href="http://www.mongodb.org/" target="_blank" class="externalLink">MongoDB</a>
is a scalable, 
 			high-performance, open source, document-oriented database.</p>
 		
+			<subsection name="Layout">
+				<p>This appender does not require a layout.</p>
+			</subsection>
+		
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>
 		
@@ -101,7 +105,6 @@
 <pre class="prettyprint"><![CDATA[
 <configuration xmlns="http://logging.apache.org/log4php/">
     <appender name="default" class="LoggerAppenderMongoDB">
-        <layout class="LoggerLayoutTTCC" />
         <param name="host" value="mongodb://example.com" />
         <param name="username" value="logger" />
         <param name="password" value="secret" />
@@ -118,9 +121,6 @@ array(
     'appenders' => array(
         'default' => array(
             'class' => 'LoggerAppenderMongoDB',
-            'layout' => array(
-                'class' => 'LoggerLayoutTTCC',
-            ),
             'params' => array(
                 'host' => 'mongodb://example.com',
                 'username' => 'logger',

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/null.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/null.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/null.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/null.xml Wed Dec 14 11:24:06 2011
@@ -28,7 +28,13 @@
 			<p><code>LoggerAppenderNull</code> ignores all logging requests; it
never outputs a message to any 
 			device.</p>
 			
-			<p>This appender does not use a layout and has no configurable parameters.</p>
+			<subsection name="Layout">
+				<p>This appender does not require a layout.</p>
+			</subsection>
+			
+			<subsection name="Parameters">
+				<p>This appender does not have any configurable parameters.</p>
+			</subsection>
 			
 			<subsection name="Examples">
 				

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/pdo.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/pdo.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/pdo.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/pdo.xml Wed Dec 14 11:24:06 2011
@@ -28,6 +28,10 @@
 			<p><code>LoggerAppenderPDO</code> appender logs to a database using
the PHP's 
 			<a href="http://php.net/manual/en/book.pdo.php" target="_blank" class="externalLink">PDO
extension</a>.</p>
 		
+			<subsection name="Layout">
+				<p>This appender does not require a layout.</p>
+			</subsection>
+		
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>
 		

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/php.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/php.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/php.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/php.xml Wed Dec 14 11:24:06 2011
@@ -36,6 +36,10 @@
 				<li><code>E_USER_ERROR</code> when the event's level is equal to or
greater than ERROR</li>
 			</ul>
 			
+			<subsection name="Layout">
+				<p>This appender requires a layout. If no layout is specified in configuration,

+				<code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code>
will be used by default.</p>
+			</subsection>	
 		
 			<subsection name="Parameters">
 				<p>This appender has no configurable parameters.</p>

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/rolling-file.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/rolling-file.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/rolling-file.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/rolling-file.xml Wed Dec 14 11:24:06
2011
@@ -37,6 +37,11 @@
 			<p>This continues until the maximum backup index is reached, after which the oldest
log file is deleted
 			on each rollover.</p>
 			
+			<subsection name="Layout">
+				<p>This appender requires a layout. If no layout is specified in configuration,

+				<code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code>
will be used by default.</p>
+			</subsection>
+			
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>
 		

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/socket.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/socket.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/socket.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/socket.xml Wed Dec 14 11:24:06 2011
@@ -27,9 +27,12 @@
 		
 			<p><code>LoggerAppenderSocket</code> appends to a network socket.</p>
 			
-			<p>Unlike most other appenders, the default layout for this appender is <code>LoggerLayoutSerialized</code>.</p>
-			
-			<p>Prior to version <code>2.2</code>, a layout was not required.</p>
+			<subsection name="Layout">
+				<p>This appender requires a layout. If no layout is specified in configuration,

+				<code><a href="../layouts/serialized.html">LoggerLayoutSerialized</a></code>
will be used by default.</p>
+				
+				<p>Prior to version <code>2.2</code>, a layout was not required.</p>
+			</subsection>
 			
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>

Modified: logging/log4php/trunk/src/site/xdoc/docs/appenders/syslog.xml
URL: http://svn.apache.org/viewvc/logging/log4php/trunk/src/site/xdoc/docs/appenders/syslog.xml?rev=1214166&r1=1214165&r2=1214166&view=diff
==============================================================================
--- logging/log4php/trunk/src/site/xdoc/docs/appenders/syslog.xml (original)
+++ logging/log4php/trunk/src/site/xdoc/docs/appenders/syslog.xml Wed Dec 14 11:24:06 2011
@@ -27,7 +27,10 @@
 		
 			<p><code>LoggerAppenderSyslog</code> logs events to the syslog.</p>
 			
-			<p>This appender does not require a layout.</p>
+			<subsection name="Layout">
+				<p>This appender requires a layout. If no layout is specified in configuration,

+				<code><a href="../layouts/simple.html">LoggerLayoutSimple</a></code>
will be used by default.</p>
+			</subsection>	
 			
 			<subsection name="Parameters">
 				<p>The following parameters are available:</p>
@@ -80,7 +83,7 @@
 							<td>option</td>
 							<td>string</td>
 							<td>No</td>
-							<td><code>PID | CONS</code></td>
+							<td><code>PID|CONS</code></td>
 							<td>Syslog options. <a href="#Options">See below</a> for available
options.</td>
 						</tr>
 					</tbody>
@@ -297,6 +300,8 @@
 			</subsection>
 				
 			<subsection name="Examples">
+			
+				<p>Here is a sample configuration:</p>
 				
 				<ul class="tabs">
 					<li class="active"><a href="#xml">XML</a></li>



Mime
View raw message