From 118b90db2ef9b606ce6cf52683a3b9cd593dfa43 Mon Sep 17 00:00:00 2001
From: Robert Gemmell <robbie@apache.org>
Date: Thu, 1 Apr 2010 15:47:30 +0000
Subject: QPID-2472: Correct log4j XML configuration comments

Applied patch from Andrew Kennedy <andrew.international@gmail.com>


git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@930015 13f79535-47bb-0310-9956-ffa450edef68
---
 qpid/java/broker/etc/log4j.xml | 63 +++++++++++++++++++++++++-----------------
 1 file changed, 37 insertions(+), 26 deletions(-)

diff --git a/qpid/java/broker/etc/log4j.xml b/qpid/java/broker/etc/log4j.xml
index ba8950dcd0..bfc331f373 100644
--- a/qpid/java/broker/etc/log4j.xml
+++ b/qpid/java/broker/etc/log4j.xml
@@ -22,39 +22,50 @@
 
 <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="null" threshold="null">
     <appender class="org.apache.log4j.QpidCompositeRollingAppender" name="ArchivingFileAppender">
-        <!-- Ensure that logs allways have the dateFormat set Default: TRUE-->
+        <!-- Ensure that logs always have the DatePattern appended to the filename.
+             DEFAULT IF NOT CONFIGURED: true -->
         <param name="StaticLogFileName" value="true"/>
-	<param name="file" value="${QPID_WORK}/log/${logprefix}qpid${logsuffix}.log"/>
-	<!-- Style of rolling to use, by:
-	        File Size (1), 
-		Date(2), 
-		Both(3) - DEFAULT
-	   When Date (or Both) is enabled then the value of DatePattern will determine
-	   when the new file is made. e.g. a DatePattern of "'.'yyyy-MM-dd-HH-mm"
-	   which includes minutes will cause a new backup file to be made every minute.
-	 -->
-	<param name="RollingStyle" value="1"/>
-        <!-- Change the direction so newer files have bigger numbers -->
-        <!-- 
-	 negative means backups become <latest>,.0,.1,2,...,n	 	
-	 0 means backup name is date stampted and follow Positive number if DataPattern clashes.
-	 Positive means backup becomes <lastest,n,n-1,n-2,..0
-	 
-	 Default is negative.
-	 -->	 	 
+        <param name="file" value="${QPID_WORK}/log/${logprefix}qpid${logsuffix}.log"/>
+        <!-- Style of rolling to use, by:
+             File Size(1)
+             Date(2)
+             Both(3)
+
+             When Date (or Both) is enabled then the value of DatePattern will determine
+             when the new file is made. e.g. a DatePattern of "'.'yyyy-MM-dd-HH-mm"
+             which includes minutes will cause a new backup file to be made every minute.
+
+             DEFAULT IF NOT CONFIGURED: 3 -->
+        <param name="RollingStyle" value="1"/>
+        <!-- Set the count direction:
+             Positive numbers mean backups are numbered <latest>, .0, .1, .2,..., .n
+             0 means backup is DatePattern stamped and followed with a Positive number
+                 if the DatePattern stamp clashes with other existing backups.
+             Negative numbers mean backups are numbered 0, 1, 2, ..., n, <latest>
+
+             DEFAULT IF NOT CONFIGURED: -1 -->
         <param name="CountDirection" value="0"/>
-        <!-- Use default 1MB -->
+        <!-- Maximum File Size:
+             DEFAULT IF NOT CONFIGURED: 10MB -->
         <param name="MaxFileSize" value="1MB"/>
+        <!-- Date Pattern:
+             DEFAULT IF NOT CONFIGURED: "'.'yyyy-MM-dd" -->
         <param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm"/>
-        <!-- Unlimited number of backups : Default: 0, no backups, -1 infinite -->
+        <!-- Maximum number of backup files:
+              0 means no backups
+             -1 means infinite backups
+
+             DEFAULT IF NOT CONFIGURED: 0 -->
         <param name="MaxSizeRollBackups" value="-1"/>
-        <!-- Compress(gzip) the backup files default:FALSE-->
+        <!-- Compress(gzip) the backup files to the backup location:
+             DEFAULT IF NOT CONFIGURED: FALSE -->
         <param name="CompressBackupFiles" value="true"/>
-        <!-- Compress the backup files using a second thread  DEFAULT: FALSE-->
+        <!-- Compress the backup files using a second thread:
+             DEFAULT IF NOT CONFIGURED: FALSE -->
         <param name="CompressAsync" value="true"/>
-        <!-- Backup Location : Default same dir as log file -->
-	<param name="backupFilesToPath" value="${QPID_WORK}/backup/log"/>
-
+        <!-- Backup Location:
+             DEFAULT IF NOT CONFIGURED: same dir as log file -->
+        <param name="backupFilesToPath" value="${QPID_WORK}/backup/log"/>
 
         <layout class="org.apache.log4j.PatternLayout">
             <param name="ConversionPattern" value="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/>
-- 
cgit v1.2.1