Improving the documentation for logging configuration in Apache Tomcat
authorkkolinko <kkolinko@13f79535-47bb-0310-9956-ffa450edef68>
Wed, 22 Sep 2010 14:48:53 +0000 (14:48 +0000)
committerkkolinko <kkolinko@13f79535-47bb-0310-9956-ffa450edef68>
Wed, 22 Sep 2010 14:48:53 +0000 (14:48 +0000)
git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@1000003 13f79535-47bb-0310-9956-ffa450edef68

webapps/docs/logging.xml

index a0f8063..cf6d377 100644 (file)
   <section name="Introduction">
     <p>
       Tomcat uses 
-      <a href="http://commons.apache.org/logging">Commons Logging</a>
-      throughout its internal code allowing the 
-      developer to choose a logging configuration that suits their needs, e.g
-      java.util.logging or 
-      <a href="http://logging.apache.org/log4j">Log4J</a>. 
+      <a href="http://commons.apache.org/logging">Apache Commons Logging</a>
+      throughout its internal code. 
       Commons Logging provides Tomcat with the ability to log
       hierarchically across various log levels without needing to rely on a
-     particular logging implementation.
+      particular logging implementation.
     </p>
 
     <p>
       By default, only java.util.logging is available for the logs generated by
       the Tomcat internal loggers, as Tomcat uses a package renamed commons
       logging implementation which is hardcoded to use java.util.logging. Use of
-      alternative logging frameworks requires building or downloading the
-      <a href="extras.html">extras</a> components which include a full
+      alternative logging frameworks requires building or downloading an
+      <a href="extras.html">extras</a> component which include a full
       commons-logging implementation. Instructions for configuring the extras
       components to enable log4j to be used for Tomcat's internal logging may be
       found below.
       Tomcat no longer uses <code>localhost_log</code> as the runtime
       exception/stack trace log. These types of error are usually thrown by
       uncaught exceptions, but are still valuable to the developer. They can now
-      be found in the <code>stdout</code> log.
+      be found in the <code>stdout</code> log file (<code>catalina.out</code>).
     </p>
 
   </section>
 
-  <section name="java.util.logging">
+  <section name="Using java.util.logging (default)">
 
   <p>
     The default implementation of java.util.logging provided in the JDK is too
@@ -225,7 +222,7 @@ java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
 
   </section>
 
-  <section name="log4j">
+  <section name="Using Log4j">
     <p>
       This section explains how to configure Tomcat to use log4j rather than
       java.util.logging for all Tomcat's internal logging. The following steps