Mark deprecated modules as such.

diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index 831fad9778cce5b14187a84611925d60bbd6425b..ce042a5a627093b7fd458c5eff1e63f9270e7a98 100644 (file)
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -79,6 +79,9 @@ As you can see, the module-specific markup consists of two directives, the
    The ``synopsis`` option should consist of one sentence describing the
    module's purpose -- it is currently only used in the Global Module Index.
 
+   The ``deprecated`` option can be given (with no value) to mark a module as
+   deprecated; it will be designated as such in various locations then.
+
 .. describe:: moduleauthor
 
    The ``moduleauthor`` directive, which can appear multiple times, names the
@@ -333,6 +336,13 @@ the current module, or the built-in function of that name.  In contrast,
 ``:func:`foo.filter``` clearly refers to the ``filter`` function in the ``foo``
 module.
 
+Normally, names in these roles are searched first without any further
+qualification, then with the current module name prepended, then with the
+current module and class name (if any) prepended.  If you prefix the name with a
+dot, this order is reversed.  For example, in the documentation of the
+:mod:`codecs` module, ``:func:`open``` always refers to the built-in function,
+while ``:func:`.open``` refers to :func:`codecs.open`.
+
 A similar heuristic is used to determine whether the name is an attribute of
 the currently documented class.
 

diff --git a/Doc/library/md5.rst b/Doc/library/md5.rst
index 4408372a2ed0731fd73b58805a18b72ac4bd549a..0495ff5dca02604a7d2fa822e58ac71915d19995 100644 (file)
--- a/Doc/library/md5.rst
+++ b/Doc/library/md5.rst
@@ -4,6 +4,7 @@
 
 .. module:: md5
    :synopsis: RSA's MD5 message digest algorithm.
+   :deprecated:
 
 
 .. deprecated:: 2.5

diff --git a/Doc/library/mimetools.rst b/Doc/library/mimetools.rst
index 603bec6ef2dfa8f58f409dd13ae0ee5d0dcb11b9..8da385e0ce5a697cef8734c29c2620a66f3fb4c0 100644 (file)
--- a/Doc/library/mimetools.rst
+++ b/Doc/library/mimetools.rst
@@ -4,6 +4,7 @@
 
 .. module:: mimetools
    :synopsis: Tools for parsing MIME-style message bodies.
+   :deprecated:
 
 
 .. deprecated:: 2.3

diff --git a/Doc/library/mimewriter.rst b/Doc/library/mimewriter.rst
index cf93473e439744de622813b5af7abeace82cfcf9..2070ff614d73e2b90a671e4f23820b7e9856b197 100644 (file)
--- a/Doc/library/mimewriter.rst
+++ b/Doc/library/mimewriter.rst
@@ -3,6 +3,7 @@
 
 .. module:: MimeWriter
    :synopsis: Write MIME format files.
+   :deprecated:
 
 .. sectionauthor:: Christopher G. Petrilli <petrilli@amber.org>
 

diff --git a/Doc/library/mimify.rst b/Doc/library/mimify.rst
index c5e13593061710c462dece3746ec1077fe43c568..da0eaccfbe10ae7a06675d21e20d9426f5877193 100644 (file)
--- a/Doc/library/mimify.rst
+++ b/Doc/library/mimify.rst
@@ -4,6 +4,7 @@
 
 .. module:: mimify
    :synopsis: Mimification and unmimification of mail messages.
+   :deprecated:
 
 
 .. deprecated:: 2.3

diff --git a/Doc/library/multifile.rst b/Doc/library/multifile.rst
index c36ccb7a0fa2a938fa96185ec01a62104f1ca8e2..3e7922968b157ca9f51bc7fbc9d52982d27b7fde 100644 (file)
--- a/Doc/library/multifile.rst
+++ b/Doc/library/multifile.rst
@@ -4,6 +4,7 @@
 
 .. module:: multifile
    :synopsis: Support for reading files which contain distinct parts, such as some MIME data.
+   :deprecated:
 .. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com>
 
 

diff --git a/Doc/library/popen2.rst b/Doc/library/popen2.rst
index d685785ffc832f8787b3c80a0c8b827ae2e08daf..826dff025ab8a1bc0254281f53dfc1891f09ac3e 100644 (file)
--- a/Doc/library/popen2.rst
+++ b/Doc/library/popen2.rst
@@ -4,6 +4,7 @@
 
 .. module:: popen2
    :synopsis: Subprocesses with accessible standard I/O streams.
+   :deprecated:
 .. sectionauthor:: Drew Csillag <drew_csillag@geocities.com>
 
 

diff --git a/Doc/library/posixfile.rst b/Doc/library/posixfile.rst
index ec58b94635c98b6a11f27164becd1142a7e5bca5..5ed348331548fe724e363fcb4cb1e6f38d58b670 100644 (file)
--- a/Doc/library/posixfile.rst
+++ b/Doc/library/posixfile.rst
@@ -7,6 +7,7 @@
 .. module:: posixfile
    :platform: Unix
    :synopsis: A file-like object with support for locking.
+   :deprecated:
 .. moduleauthor:: Jaap Vermeulen
 .. sectionauthor:: Jaap Vermeulen
 

diff --git a/Doc/library/rfc822.rst b/Doc/library/rfc822.rst
index fa25ba5b1bf8d09a32c9640ebb3a084b8e0e0d79..52df0130bf41befff5944ed1895ba5d29c60a92b 100644 (file)
--- a/Doc/library/rfc822.rst
+++ b/Doc/library/rfc822.rst
@@ -4,6 +4,7 @@
 
 .. module:: rfc822
    :synopsis: Parse 2822 style mail messages.
+   :deprecated:
 
 
 .. deprecated:: 2.3

diff --git a/Doc/library/sets.rst b/Doc/library/sets.rst
index 10cd6a0d364db3698583b757e6a6d718dab209cc..f9f8b599923e9a98bf3522a6922c753f29dec51b 100644 (file)
--- a/Doc/library/sets.rst
+++ b/Doc/library/sets.rst
@@ -4,6 +4,7 @@
 
 .. module:: sets
    :synopsis: Implementation of sets of unique elements.
+   :deprecated:
 .. moduleauthor:: Greg V. Wilson <gvwilson@nevex.com>
 .. moduleauthor:: Alex Martelli <aleax@aleax.it>
 .. moduleauthor:: Guido van Rossum <guido@python.org>

diff --git a/Doc/library/sha.rst b/Doc/library/sha.rst
index 7af043e6a9b294b01e7f7bd5e6f401aacd3de673..3851d942b07c39a372a3a35f90571a2f20416869 100644 (file)
--- a/Doc/library/sha.rst
+++ b/Doc/library/sha.rst
@@ -4,6 +4,7 @@
 
 .. module:: sha
    :synopsis: NIST's secure hash algorithm, SHA.
+   :deprecated:
 .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
 
 

diff --git a/Doc/library/stringprep.rst b/Doc/library/stringprep.rst
index b0944e43730dbb2ed843d4c5be41387054a15bfb..d2f269c119a699a53abc336a66b7ad5e890e57df 100644 (file)
--- a/Doc/library/stringprep.rst
+++ b/Doc/library/stringprep.rst
@@ -4,6 +4,7 @@
 
 .. module:: stringprep
    :synopsis: String preparation, as per RFC 3453
+   :deprecated:
 .. moduleauthor:: Martin v. Löwis <martin@v.loewis.de>
 .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de>
 

diff --git a/Doc/library/xmllib.rst b/Doc/library/xmllib.rst
index 04ca27e813c8dbcd4d0467c2eb68f6e6a42f0177..d14754c6a13d092597261a66e53a771e66fae67f 100644 (file)
--- a/Doc/library/xmllib.rst
+++ b/Doc/library/xmllib.rst
@@ -4,6 +4,7 @@
 
 .. module:: xmllib
    :synopsis: A parser for XML documents.
+   :deprecated:
 .. moduleauthor:: Sjoerd Mullender <Sjoerd.Mullender@cwi.nl>
 .. sectionauthor:: Sjoerd Mullender <Sjoerd.Mullender@cwi.nl>
 

diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
index 5e51bfc85496822be76032a4366ccfcd3d907c02..ccc3114c8481be008a0a87ddef3de511ed193a2f 100644 (file)
--- a/Doc/library/zipfile.rst
+++ b/Doc/library/zipfile.rst
@@ -168,11 +168,11 @@ ZipFile Objects
    .. note::
 
       If the ZipFile was created by passing in a file-like object as the  first
-      argument to the constructor, then the object returned by :meth:`open` shares the
+      argument to the constructor, then the object returned by :meth:`.open` shares the
       ZipFile's file pointer.  Under these  circumstances, the object returned by
-      :meth:`open` should not  be used after any additional operations are performed
+      :meth:`.open` should not  be used after any additional operations are performed
       on the  ZipFile object.  If the ZipFile was created by passing in a string (the
-      filename) as the first argument to the constructor, then  :meth:`open` will
+      filename) as the first argument to the constructor, then  :meth:`.open` will
       create a new file object that will be held by the ZipExtFile, allowing it to
       operate independently of the  ZipFile.