[Zope-Checkins] CVS: ZODB3/ZODB - component.xml:1.6

[Fred L. Drake, Jr.]

Update of /cvs-repository/ZODB3/ZODB
In directory cvs.zope.org:/tmp/cvs-serv28994

Modified Files:
	component.xml 
Log Message:
The "stop" argument for the FileStorage constructor can't be
meaningfully used the way the config schema currently defines the
field, so remove it.

Document the remaining settings for filestorage.


=== ZODB3/ZODB/component.xml 1.5 => 1.6 ===
--- ZODB3/ZODB/component.xml:1.5	Fri Jan 17 15:07:22 2003
+++ ZODB3/ZODB/component.xml	Tue Jan 28 18:18:14 2003
@@ -7,16 +7,34 @@
 
   <sectiontype name="filestorage" datatype=".FileStorage"
                implements="storage">
-    <key name="path" required="yes"/>
+    <key name="path" required="yes">
+      <description>
+        Path name to the main storage file.  The names for
+        supplemental files, including index and lock files, will be
+        computed from this.
+      </description>
+    </key>
     <key name="create" datatype="boolean" default="false">
       <description>
         Flag that indicates whether the storage should be truncated if
         it already exists.
       </description>
     </key>
-    <key name="read-only" datatype="boolean" default="false"/>
-    <key name="stop"/>
-    <key name="quota" datatype="integer"/>
+    <key name="read-only" datatype="boolean" default="false">
+      <description>
+        If true, only reads may be executed against the storage.  Note
+        that the "pack" operation is not considered a write operation
+        and is still allowed on a read-only filestorage.
+      </description>
+    </key>
+    <key name="quota" datatype="byte-size">
+      <description>
+        Maximum allowed size of the storage file.  Operations which
+        would cause the size of the storage to exceed the quota will
+        result in a ZODB.FileStorage.FileStorageQuotaError being
+        raised.
+      </description>
+    </key>
   </sectiontype>
 
   <sectiontype name="mappingstorage" datatype=".MappingStorage"