[Zope3-checkins] CVS: ZODB/src/ZConfig/components/logger - logger.xml:1.3

[Fred L. Drake, Jr.]

Update of /cvs-repository/ZODB/src/ZConfig/components/logger
In directory cvs.zope.org:/tmp/cvs-serv31075

Modified Files:
	logger.xml 
Log Message:
fill in some documentation


=== ZODB/src/ZConfig/components/logger/logger.xml 1.2 => 1.3 ===
--- ZODB/src/ZConfig/components/logger/logger.xml:1.2	Fri Jan  2 17:58:13 2004
+++ ZODB/src/ZConfig/components/logger/logger.xml	Fri Apr  9 17:33:08 2004
@@ -5,11 +5,39 @@
   <import package="ZConfig.components.logger" file="abstract.xml"/>
 
   <sectiontype name="ZConfig.logger.base-logger">
-     <key name="level"
-          datatype="ZConfig.components.logger.datatypes.logging_level"
-          default="info"/>
-     <multisection type="ZConfig.logger.handler"
-                   attribute="handlers" name="*"/>
+    <key name="level"
+         datatype="ZConfig.components.logger.datatypes.logging_level"
+         default="info">
+      <description>
+        Verbosity setting for the logger.  Values must be a name of
+        a level, or an integer in the range [0..50].  The names of the
+        levels, in order of increasing verbosity (names on the same
+        line are equivalent):
+
+            critical, fatal
+            error
+            warn, warning
+            info
+            blather
+            debug
+            trace
+            all
+
+        The special name "notset", or the numeric value 0, indicates
+        that the setting for the parent logger should be used.
+
+        It is strongly recommended that names be used rather than
+        numeric values to ensure that configuration files can be
+        deciphered more easily.
+      </description>
+    </key>
+    <multisection type="ZConfig.logger.handler"
+                  attribute="handlers" name="*">
+      <description>
+        Handlers to install on this logger.  Each handler describes
+        how logging events should be presented.
+      </description>
+    </multisection>
   </sectiontype>
 
   <sectiontype name="logger"
@@ -20,6 +48,12 @@
          datatype="boolean"
          default="true">
       <description>
+        Indicates whether events that reach this logger should be
+        propogated toward the root of the logger hierarchy.  If true
+        (the default), events will be passed to the logger's parent
+        after being handled.  If false, events will be handled and the
+        parent will not be informed.  There is not a way to control
+        propogation by the severity of the event.
       </description>
     </key>
 
@@ -27,6 +61,11 @@
          datatype="dotted-name"
          required="yes">
       <description>
+        The dotted name of the logger.  This give it a location in the
+        logging hierarchy.  Most applications provide a specific set
+        of subsystem names for which logging is meaning; consult the
+        application documentation for the set of names that are
+        actually interesting for the application.
       </description>
     </key>
   </sectiontype>
@@ -36,8 +75,7 @@
                extends="ZConfig.logger.base-logger"
                implements="ZConfig.logger.log">
     <description>
-      Logger bound to the name "event".  Propogation of events to the
-      root logger is disabled.
+      Configuration for the root logger.
     </description>
   </sectiontype>