rdonkin 02/04/18 10:44:43
Modified: digester/src/java/org/apache/commons/digester package.html
Log:
Updated and corrected digester documentation to reflect use of commons logging
(rather than the old print writer)
Revision Changes Path
1.10 +29 -6
jakarta-commons/digester/src/java/org/apache/commons/digester/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/jakarta-commons/digester/src/java/org/apache/commons/digester/package.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- package.html 17 Apr 2002 19:16:34 -0000 1.9
+++ package.html 18 Apr 2002 17:44:43 -0000 1.10
@@ -14,6 +14,7 @@
<a href="#doc.Stack">[The Object Stack]</a>
<a href="#doc.Patterns">[Element Matching Patterns]</a>
<a href="#doc.Rules">[Processing Rules]</a>
+<a href="#doc.Logging">[Logging]</a>
<a href="#doc.Usage">[Usage Example]</a>
<a href="#doc.Namespace">[Namespace Aware Parsing]</a>
<a href="#doc.Pluggable">[Pluggable Rules Processing]</a>
@@ -39,6 +40,10 @@
<a
href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-collections";>
Collections Package (Jakarta Commons)</a>, version 1.0 or later
</li>
+ <li>
+ <a
href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-logging";>
+Commons Logging Package (Jakarta Commons)</a>, version 1.0 or later
+ </li>
</ul>
<a name="doc.Intro"></a>
@@ -167,12 +172,6 @@
value of <code>false</code> requests a parse that only detects
"well formed" XML documents, rather than "valid" ones.</td>
</tr>
- <tr>
- <td align="center">writer</td>
- <td>A <code>PrintWriter</code> to which all log output generated by
- <code>Digester</code> is directed. By default, all log output is
- directed to <code>System.out</code>.</td>
- </tr>
</table>
</blockquote>
@@ -442,6 +441,30 @@
digester.addSetNext("a/b/c", "addChild",
"com.mycompany.mypackage.MyChildClass");
</pre>
+
+<a name="doc.Logging"></a>
+<h3>Logging</h3>
+
+<p>Logging is a vital tool for debugging Digester rulesets. Digester can log
copious
+amounts of debugging information. So, you need to know how logging works
+before you start using Digester seriously.</p>
+
+<p>Digester uses <a href="http://jakarta.apache.org/commons/logging.html";>Jakarta
+Commons Logging</a>. This component is not really a logging framework - rather
+an extensible, configurable bridge. It can be configured to swallow all log
+messages, to provide very basic logging by itself or to pass logging messages
+on to more sophisticated logging frameworks. Commons-logging comes with connectors
+for many popular logging frameworks. Consult the commons-logging documentation for
+more information.</p>
+
+<p>Two main logs are used by Digester.
+<ul>
+<li>SAX-related messages are logged to
+<strong><code>org.apache.commons.digester.Digester.sax</code></strong>. This log
gives
+information about the basic SAX events received by digester.</li>
+<li><strong><code>org.apache.commons.digester.Digester</code></strong> is used for
+ everything else. You'll probably want to have this log turned up during debugging
but turned down
+ during production due to the high message volume.</li></ul></p>
<a name="doc.Usage"></a>
<h3>Usage Examples</h3>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
