[logback-dev] svn commit: r1100 - in logback/trunk: log4j-bridge/compatibility logback-site/src/site/xdocTemplates

[noreply.seb at qos.ch]

Author: seb
Date: Mon Dec 18 11:25:26 2006
New Revision: 1100

Modified:
   logback/trunk/log4j-bridge/compatibility/readme.txt
   logback/trunk/logback-site/src/site/xdocTemplates/bridge.xml

Log:
Moved test information in the readme file
Modified bridge.xml to include information about the situations where the module does not work

Modified: logback/trunk/log4j-bridge/compatibility/readme.txt
==============================================================================
--- logback/trunk/log4j-bridge/compatibility/readme.txt	(original)
+++ logback/trunk/log4j-bridge/compatibility/readme.txt	Mon Dec 18 11:25:26 2006
@@ -4,9 +4,19 @@
 |                          |
 #--------------------------#
 
-This directory contains the compatibility tests of the log4j-bridge module.
+This directory is used to test the module against various log4j calls. 
+Two test cases simulate the typical calls that one can find in an application 
+that uses either log4j 1.2.x, or log4j 1.3.x.
 
-They use two test cases, one for log4j 1.2 calls, and one for log4j 1.3 calls.
+In the same directory is a build.xml file that uses ant to 
+compile the test cases with the corresponding log4j version, 
+and to runs these tests without log4j in the classpath but with 
+logback jars instead.
 
-To obtain more information about this directory, or the use of the log4j-bridge
-module and its tests, please visit http://logback.qos.ch/bridge.html
\ No newline at end of file
+To run the tests, one must have ant installed. Issuing the following command, 
+once in the compatibility directory will launch the tests:
+
+ant all
+
+To obtain more information about the use of the log4j-bridge module, 
+please visit http://logback.qos.ch/bridge.html
\ No newline at end of file

Modified: logback/trunk/logback-site/src/site/xdocTemplates/bridge.xml
==============================================================================
--- logback/trunk/logback-site/src/site/xdocTemplates/bridge.xml	(original)
+++ logback/trunk/logback-site/src/site/xdocTemplates/bridge.xml	Mon Dec 18 11:25:26 2006
@@ -23,7 +23,8 @@
     <p>The log4j-bridge module contains replacements of most widely
     used log4j classes, namely <code>Category</code>,
     <code>Level</code>, <code>Logger</code>, <code>MDC</code>,
-    <code>Priority</code>, and <code>Log4jLoggerFactory</code>.  These
+    <code>Priority</code>, <code>BasicConfigurator</code>
+    and <code>Log4jLoggerFactory</code>.  These
     replacement classes redirect loggging calls to the corresponding
     logback methods.
     </p>
@@ -59,26 +60,21 @@
 			which are logback dependencies. A file called <em>logback.xml</em>, 
 			placed in the application's classpath, will be automatically loaded by logback.
 		</p>
-		
-		<h3>Running the log4j-bridge tests</h3>
-		<p>
-			The log4j-bridge module contains a <em>compatibility</em> directory that is used to
-			test the module against various log4j calls. Two test cases simulate the typical calls
-			that one can find in an application that uses either log4j 1.2.x, or log4j 1.3.x.
-		</p>
-		<p>
-			In the same directory is a <em>build.xml</em> file that uses ant to 
-			compile the test cases with the corresponding log4j version, 
-			and to runs these tests without log4j in the classpath but with 
-			logback jars instead.
-		</p>
+
+    <h3>When does it not work?</h3>
+    
+    <p>
+    	The <em>log4-bridge</em> module does not work when the application calls
+    	log4j components that are not present in the bridge.
+    	For examples, direct creation of log4j <code>Appenders</code> or 
+    	<code>Filters</code> will not work.
+    </p>
 		
 		<p>
-			To run the tests, one must have ant installed. Issuing the following command, 
-			once in the <em>compatibility</em> directory will launch the tests:
+			However, in most situations, log4j finds its configuration file and 
+			configures itself. In these cases, the application will only issue calls
+			to the classes that are contained in the <em>log4j-bridge</em>.
 		</p>
-		
-<div class="source"><pre>ant all</pre></div>
 
 	</body>
 </document>
\ No newline at end of file