[Checkins] SVN: relstorage/trunk/ wording
Shane Hathaway
shane at hathawaymix.org
Sat Oct 3 18:13:13 EDT 2009
Log message for revision 104769:
wording
Changed:
U relstorage/trunk/README.txt
U relstorage/trunk/relstorage/component.xml
-=-
Modified: relstorage/trunk/README.txt
===================================================================
--- relstorage/trunk/README.txt 2009-10-03 21:54:16 UTC (rev 104768)
+++ relstorage/trunk/README.txt 2009-10-03 22:13:12 UTC (rev 104769)
@@ -243,25 +243,26 @@
underscores instead of dashes in the parameter names.
``name``
- The name of the storage. Defaults to a descriptive name
- that includes most of the adapter configuration parameters
- except the database password.
+ The name of the storage. Defaults to a descriptive name that
+ includes the adapter connection parameters, except the database
+ password.
``read-only``
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.
+ and is still allowed on a read-only storage.
``blob-dir``
- If supplied, the storage will provide blob support and this
- is the name of a directory to hold blob data. The directory will
- be created if it doeesn't exist. If no value (or an empty value)
- is provided, then no blob support will be provided.
+ If supplied, the storage will provide blob support; this
+ parameter specifies the name of the directory to hold blob data.
+ The directory will be created if it doeesn't exist. If no value
+ (or an empty value) is provided, then no blob support will be
+ provided.
``keep-history``
If this parameter is set to true (the default), the adapter
will create and use a history-preserving database schema
- like FileStorage. A history-preserving schema supports
+ (like FileStorage). A history-preserving schema supports
ZODB-level undo, but also grows more quickly and requires extensive
packing on a regular basis.
@@ -389,7 +390,7 @@
PostgreSQL Adapter Options
--------------------------
-In addition to the common options, the PostgreSQL adapter accepts:
+The PostgreSQL adapter accepts:
``dsn``
Specifies the data source name for connecting to PostgreSQL.
@@ -405,8 +406,8 @@
MySQL Adapter Options
---------------------
-In addition to the common options, this adapter accepts most parameters
-supported by the MySQL-python library, including:
+The MySQL adapter accepts most parameters supported by the MySQL-python
+library, including:
``host``
string, host to connect
@@ -443,7 +444,7 @@
Oracle Adapter Options
----------------------
-In addition to the common options, the Oracle adapter accepts:
+The Oracle adapter accepts:
``user``
The Oracle account name
Modified: relstorage/trunk/relstorage/component.xml
===================================================================
--- relstorage/trunk/relstorage/component.xml 2009-10-03 21:54:16 UTC (rev 104768)
+++ relstorage/trunk/relstorage/component.xml 2009-10-03 22:13:12 UTC (rev 104769)
@@ -15,23 +15,24 @@
<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.
+ and is still allowed on a read-only storage.
</description>
</key>
<key name="blob-dir" required="no">
<description>
- If supplied, the storage will provide blob support and this
- is the name of a directory to hold blob data. The directory will
- be created if it doeesn't exist. If no value (or an empty value)
- is provided, then no blob support will be provided.
+ If supplied, the storage will provide blob support; this
+ parameter specifies the name of the directory to hold blob data.
+ The directory will be created if it doeesn't exist. If no value
+ (or an empty value) is provided, then no blob support will be
+ provided.
</description>
</key>
<key name="keep-history" datatype="boolean" default="true">
<description>
If this parameter is set to true (the default), the adapter
- will create and use a history-preserving database schema,
- similar to FileStorage. A history-preserving schema supports
- ZODB-level undo, but grows more quickly and requires extensive
+ will create and use a history-preserving database schema
+ (like FileStorage). A history-preserving schema supports
+ ZODB-level undo, but also grows more quickly and requires extensive
packing on a regular basis.
If this parameter is set to false, the adapter will create and
@@ -41,9 +42,10 @@
through the database pack mechanism.)
This parameter must not change once the database schema has
- been installed. If you want to convert between a
- history-preserving and a history-free database, use the
- zodbconvert utility to copy to a new database.
+ been installed, because the schemas for history-preserving and
+ history-free storage are different. If you want to convert
+ between a history-preserving and a history-free database, use
+ the ``zodbconvert`` utility to copy to a new database.
</description>
</key>
<key name="replica-conf" datatype="string" required="no">
More information about the checkins
mailing list