commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject cvs commit: jakarta-commons/logging/src/java/org/apache/commons/logging package.html
Date Thu, 01 May 2003 16:55:29 GMT
rdonkin     2003/05/01 09:55:29

  Modified:    logging  usersguide.html
               logging/src/java/org/apache/commons/logging package.html
  Log:
  Improved documentation.
  
  Revision  Changes    Path
  1.5       +46 -0     jakarta-commons/logging/usersguide.html
  
  Index: usersguide.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/logging/usersguide.html,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- usersguide.html	12 Dec 2002 19:56:44 -0000	1.4
  +++ usersguide.html	1 May 2003 16:55:29 -0000	1.5
  @@ -23,6 +23,7 @@
   <h3>
   Table of Contents</h3>
   <a href="#Introduction">Introduction</a>
  +<br><a href="#Users">Users Quick Start</a>
   <br><a href="#Developers">Developers</a>
   <br>&nbsp; <a href="#Best Practices">Best Practices</a>
   <br><a href="#Integration">Integration</a>
  @@ -51,6 +52,51 @@
   and
   <a>JDK 1.4</a>.
   The interface maps closely to Log4J and LogKit.
  +</p>
  +
  +<h2><a NAME="Users"></a>Users Quick Start</h2>
  +<p>
  +As far as possible, <em>Commons-Logging</em> tries to be as unobtrusive as
possible. 
  +In most cases, including the (full) <code>commons-logging.jar</code> in the
classpath
  +should result in <em>Commons-Logging</em> configuring itself in a reasonable
manner.
  +There's a good chance that it'll guess your preferred logging system and you won't
  +need to do any configuration at all!
  +</p>
  +<h3>Configuration</h3>
  +<p>
  +There are two base abstractions used by <em>Commons-Logging</em>: <code>Log</code>

  +(the basic logger) and <code>LogFactory</code> (which knows how to create <code>Log</code>
  +instances). Using <code>LogFactory</code> implementations other than the default
is a 
  +subject for advanced users only, so let's concentrate on configuring the default 
  +implementation.
  +</p>
  +<p>
  +The default <code>LogFactory</code> implementation uses the following discovery
process
  +to determine what type of <code>Log</code> implementation it should use
  +(the process terminates when the first positive match - in order - is found):
  +
  +    <ol>
  +    <li>Look for a configuration attribute of this factory named
  +        <code>org.apache.commons.logging.Log</code> (for backwards
  +        compatibility to pre-1.0 versions of this API, an attribute
  +        <code>org.apache.commons.logging.log</code> is also consulted).</li>
  +    <li>Look for a system property named
  +        <code>org.apache.commons.logging.Log</code> (for backwards
  +        compatibility to pre-1.0 versions of this API, a system property
  +        <code>org.apache.commons.logging.log</code> is also consulted).</li>
  +    <li>If the Log4J logging system is available in the application
  +        class path, use the corresponding wrapper class
  +        (<a href="impl/Log4JLogger.html">Log4JLogger</a>).</li>
  +    <li>If the application is executing on a JDK 1.4 system, use
  +        the corresponding wrapper class
  +        (<a href="impl/Jdk14Logger.html">Jdk14Logger</a>).</li>
  +    <li>Fall back to the default simple logging wrapper
  +        (<a href="impl/SimpleLog.html">SimpleLog</a>).</li>
  +    </ol>
  +    
  +Consult the <em>Commons-Logging</em> javadocs for details of the various <code>Log</code>
  +implementations that ship with the component. (The discovery process is also covered in
more
  +detail there.)
   </p>
   
   <h2><a NAME="Developers"></a>Developers</h2>
  
  
  
  1.10      +1 -1      jakarta-commons/logging/src/java/org/apache/commons/logging/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/logging/src/java/org/apache/commons/logging/package.html,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- package.html	30 Mar 2003 23:42:36 -0000	1.9
  +++ package.html	1 May 2003 16:55:29 -0000	1.10
  @@ -124,7 +124,7 @@
       <li>Look for a configuration attribute of this factory named
           <code>org.apache.commons.logging.Log</code> (for backwards
           compatibility to pre-1.0 versions of this API, an attribute
  -        <code>org.apache.commons.logging.log is also consulted)..</li>
  +        <code>org.apache.commons.logging.log</code> is also consulted).</li>
       <li>Look for a system property named
           <code>org.apache.commons.logging.Log</code> (for backwards
           compatibility to pre-1.0 versions of this API, a system property
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message