[Zodb-checkins] SVN: ZODB/trunk/src/ZODB/component.xml Add descriptions to the <zodb> section keys.

[Tim Peters]

Log message for revision 39542:
  Add descriptions to the <zodb> section keys.
  

Changed:
  U   ZODB/trunk/src/ZODB/component.xml

-=-
Modified: ZODB/trunk/src/ZODB/component.xml
===================================================================
--- ZODB/trunk/src/ZODB/component.xml	2005-10-21 00:09:10 UTC (rev 39541)
+++ ZODB/trunk/src/ZODB/component.xml	2005-10-21 02:01:24 UTC (rev 39542)
@@ -153,9 +153,29 @@
                implements="ZODB.database">
     <section type="ZODB.storage" name="*" attribute="storage"/>
     <key name="cache-size" datatype="integer" default="5000"/>
+      <description>
+        Target size, in number of objects, of each connection's
+        object cache.
+      </description>
     <key name="pool-size" datatype="integer" default="7"/>
+      <description>
+        The expected maximum number of simultaneously open connections.
+        There is no hard limit (as many connections as are requested
+        will be opened, until system resources are exhausted).  Exceeding
+        pool-size connections causes a warning message to be logged,
+        and exceeding twice pool-size connections causes a critical
+        message to be logged.
+      </description>
     <key name="version-pool-size" datatype="integer" default="3"/>
+      <description>
+        The expected maximum number of connections simultaneously open
+        per version.
+      </description>
     <key name="version-cache-size" datatype="integer" default="100"/>
+      <description>
+        Target size, in number of objects, of each version connection's
+        object cache.
+      </description>
   </sectiontype>
 
 </component>