From 68d3eb9f66d33723ce137ed3872e6c47633a4145 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Mon, 26 May 2008 10:22:15 +0000 Subject: [PATCH] Add renaming notices to 2.6 dbm module docs. --- Doc/library/anydbm.rst | 6 +++++- Doc/library/dbhash.rst | 5 ++++- Doc/library/dbm.rst | 6 +++++- Doc/library/dumbdbm.rst | 5 ++++- Doc/library/gdbm.rst | 6 +++++- Doc/library/whichdb.rst | 6 +++++- 6 files changed, 28 insertions(+), 6 deletions(-) diff --git a/Doc/library/anydbm.rst b/Doc/library/anydbm.rst index 413b7de9a7ca1f..36f0a7e6be6612 100644 --- a/Doc/library/anydbm.rst +++ b/Doc/library/anydbm.rst @@ -1,4 +1,3 @@ - :mod:`anydbm` --- Generic access to DBM-style databases ======================================================= @@ -6,6 +5,11 @@ :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 index 5d2b95ea5ba33b..bedfad4267212a 100644 --- a/Doc/library/dbhash.rst +++ b/Doc/library/dbhash.rst @@ -1,4 +1,3 @@ - :mod:`dbhash` --- DBM-style interface to the BSD database library ================================================================= @@ -6,6 +5,10 @@ :synopsis: DBM-style interface to the BSD database library. .. sectionauthor:: Fred L. Drake, Jr. +.. 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 index 52923e826de192..874778956feffa 100644 --- a/Doc/library/dbm.rst +++ b/Doc/library/dbm.rst @@ -1,4 +1,3 @@ - :mod:`dbm` --- Simple "database" interface ========================================== @@ -6,6 +5,11 @@ :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 index 3db9fda7ce7087..a511855dd0d5fa 100644 --- 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 index ce27f6c6459005..aec23e6f23f2fa 100644 --- a/Doc/library/gdbm.rst +++ b/Doc/library/gdbm.rst @@ -1,4 +1,3 @@ - :mod:`gdbm` --- GNU's reinterpretation of dbm ============================================= @@ -6,6 +5,11 @@ :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 index 5c698183fc6e96..7048a0e3550f5c 100644 --- 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`\