[Python-checkins] r46970 - python/trunk/Doc/lib/libbsddb.tex

[gregory.p.smith]

Author: gregory.p.smith
Date: Thu Jun 15 11:23:52 2006
New Revision: 46970

Modified:
   python/trunk/Doc/lib/libbsddb.tex
Log:
minor documentation cleanup.  mention the bsddb.db interface explicitly by name.


Modified: python/trunk/Doc/lib/libbsddb.tex
==============================================================================
--- python/trunk/Doc/lib/libbsddb.tex	(original)
+++ python/trunk/Doc/lib/libbsddb.tex	Thu Jun 15 11:23:52 2006
@@ -13,23 +13,29 @@
 dictionaries.  Keys and values must be strings, however, so to use
 other objects as keys or to store other kinds of objects the user must
 serialize them somehow, typically using \function{marshal.dumps()} or 
-\function{pickle.dumps}.
+\function{pickle.dumps()}.
 
 The \module{bsddb} module requires a Berkeley DB library version from
 3.3 thru 4.4.
 
 \begin{seealso}
-  \seeurl{http://pybsddb.sourceforge.net/}{Website with documentation
-  for the new python Berkeley DB interface that closely mirrors the 
-  sleepycat object oriented interface provided in Berkeley DB 3 and 4.}
+  \seeurl{http://pybsddb.sourceforge.net/}{The website with documentation
+  for the \module{bsddb.db} python Berkeley DB interface that closely mirrors
+  the Sleepycat object oriented interface provided in Berkeley DB 3 and 4.}
   \seeurl{http://www.sleepycat.com/}{Sleepycat Software produces the
-  modern Berkeley DB library.}
+  Berkeley DB library.}
 \end{seealso}
 
+A more modern DB, DBEnv and DBSequence object interface is available in the
+\module{bsddb.db} module which closely matches the Sleepycat Berkeley DB C API
+documented at the above URLs.  Additional features provided by the
+\module{bsddb.db} API include fine tuning, transactions, logging, and
+multiprocess concurrent database access.
+
 The following is a description of the legacy \module{bsddb} interface
-compatible with the old python bsddb module.  For details about the more
-modern Db and DbEnv object oriented interface see the above mentioned
-pybsddb URL.
+compatible with the old python bsddb module.  Starting in Python 2.5 this
+interface should be safe for multithreaded access.  The \module{bsddb.db}
+API is recommended for threading users as it provides better control.
 
 The \module{bsddb} module defines the following functions that create
 objects that access the appropriate type of Berkeley DB file.  The