Add renaming notices to 2.6 dbm module docs.

python · May 26, 2008 · 68d3eb9 · 68d3eb9
1 parent f9ef988
commit 68d3eb9
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 6 deletions.
diff --git a/Doc/library/anydbm.rst b/Doc/library/anydbm.rst
@@ -1,11 +1,15 @@
-
 :mod:`anydbm` --- Generic access to DBM-style databases
 =======================================================
 
 .. module:: anydbm
    :synopsis: Generic interface to DBM-style database modules.
 
 
+.. note::
+   The :mod:`anydbm` module has been renamed to :mod:`dbm` in Python 3.0.  The
+   :term:`2to3` tool will automatically adapt imports when converting your
+   sources to 3.0.
+
 .. index::
    module: dbhash
    module: bsddb

diff --git a/Doc/library/dbhash.rst b/Doc/library/dbhash.rst
@@ -1,11 +1,14 @@
-
 :mod:`dbhash` --- DBM-style interface to the BSD database library
 =================================================================
 
 .. module:: dbhash
    :synopsis: DBM-style interface to the BSD database library.
 .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
 
+.. note::
+   The :mod:`dbhash` module has been renamed to :mod:`dbm.bsd` in Python 3.0.
+   The :term:`2to3` tool will automatically adapt imports when converting your
+   sources to 3.0.
 
 .. index:: module: bsddb
 

diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst
@@ -1,11 +1,15 @@
-
 :mod:`dbm` --- Simple "database" interface
 ==========================================
 
 .. module:: dbm
    :platform: Unix
    :synopsis: The standard "database" interface, based on ndbm.
 
+.. note::
+   The :mod:`dbm` module has been renamed to :mod:`dbm.ndbm` in Python 3.0.  The
+   :term:`2to3` tool will automatically adapt imports when converting your
+   sources to 3.0.
+
 
 The :mod:`dbm` module provides an interface to the Unix "(n)dbm" library.  Dbm
 objects behave like mappings (dictionaries), except that keys and values are

diff --git a/Doc/library/dumbdbm.rst b/Doc/library/dumbdbm.rst
@@ -1,10 +1,13 @@
-
 :mod:`dumbdbm` --- Portable DBM implementation
 ==============================================
 
 .. module:: dumbdbm
    :synopsis: Portable implementation of the simple DBM interface.
 
+.. note::
+   The :mod:`dumbdbm` module has been renamed to :mod:`dbm.dumb` in Python 3.0.
+   The :term:`2to3` tool will automatically adapt imports when converting your
+   sources to 3.0.
 
 .. index:: single: databases
 

diff --git a/Doc/library/gdbm.rst b/Doc/library/gdbm.rst
@@ -1,11 +1,15 @@
-
 :mod:`gdbm` --- GNU's reinterpretation of dbm
 =============================================
 
 .. module:: gdbm
    :platform: Unix
    :synopsis: GNU's reinterpretation of dbm.
 
+.. note::
+   The :mod:`gdbm` module has been renamed to :mod:`dbm.gnu` in Python 3.0.  The
+   :term:`2to3` tool will automatically adapt imports when converting your
+   sources to 3.0.
+
 
 .. index:: module: dbm
 

diff --git a/Doc/library/whichdb.rst b/Doc/library/whichdb.rst
@@ -1,10 +1,14 @@
-
 :mod:`whichdb` --- Guess which DBM module created a database
 ============================================================
 
 .. module:: whichdb
    :synopsis: Guess which DBM-style module created a given database.
 
+.. note::
+   The :mod:`whichdb` module's only function has been put into the :mod:`dbm`
+   module in Python 3.0.  The :term:`2to3` tool will automatically adapt imports
+   when converting your sources to 3.0.
+
 
 The single function in this module attempts to guess which of the several simple
 database modules available--\ :mod:`dbm`, :mod:`gdbm`, or :mod:`dbhash`\