Mon Apr 27 18:20:51 CEST 2009

Author: georg.brandl
Date: Mon Apr 27 18:20:50 2009
New Revision: 72012

Log:
Merged revisions 72009 via svnmerge from 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r72009 | georg.brandl | 2009-04-27 17:29:09 +0200 (Mo, 27 Apr 2009) | 3 lines
  
  Demote warnings to notices where appropriate, following the goal that as few "red box" warnings
  should clutter the docs as possible.  Part 1: stuff that gets merged to Py3k.
........


Modified:
   python/branches/py3k/   (props changed)
   python/branches/py3k/Doc/c-api/intro.rst
   python/branches/py3k/Doc/documenting/markup.rst
   python/branches/py3k/Doc/extending/extending.rst
   python/branches/py3k/Doc/library/2to3.rst
   python/branches/py3k/Doc/library/aifc.rst
   python/branches/py3k/Doc/library/codeop.rst
   python/branches/py3k/Doc/library/configparser.rst
   python/branches/py3k/Doc/library/fileinput.rst
   python/branches/py3k/Doc/library/functions.rst
   python/branches/py3k/Doc/library/http.client.rst
   python/branches/py3k/Doc/library/inspect.rst
   python/branches/py3k/Doc/library/locale.rst
   python/branches/py3k/Doc/library/marshal.rst
   python/branches/py3k/Doc/library/os.path.rst
   python/branches/py3k/Doc/library/pickle.rst
   python/branches/py3k/Doc/library/string.rst
   python/branches/py3k/Doc/library/subprocess.rst
   python/branches/py3k/Doc/library/tabnanny.rst
   python/branches/py3k/Doc/library/unittest.rst
   python/branches/py3k/Doc/reference/compound_stmts.rst
   python/branches/py3k/Doc/reference/executionmodel.rst

Modified: python/branches/py3k/Doc/c-api/intro.rst
==============================================================================

--- python/branches/py3k/Doc/c-api/intro.rst	(original)
+++ python/branches/py3k/Doc/c-api/intro.rst	Mon Apr 27 18:20:50 2009
@@ -44,7 +44,7 @@
 ``<string.h>``, ``<errno.h>``, ``<limits.h>``, and ``<stdlib.h>`` (if
 available).
 
-.. warning::
+.. note::
 
    Since Python may define some pre-processor definitions which affect the standard
    headers on some systems, you *must* include :file:`Python.h` before any standard

Modified: python/branches/py3k/Doc/documenting/markup.rst
==============================================================================
--- python/branches/py3k/Doc/documenting/markup.rst	(original)
+++ python/branches/py3k/Doc/documenting/markup.rst	Mon Apr 27 18:20:50 2009
@@ -594,11 +594,11 @@
 
 .. describe:: warning
 
-   An important bit of information about an API that a user should be very aware
-   of when using whatever bit of API the warning pertains to.  The content of
-   the directive should be written in complete sentences and include all
-   appropriate punctuation. This differs from ``note`` in that it is recommended
-   over ``note`` for information regarding security.
+   An important bit of information about an API that a user should be aware of
+   when using whatever bit of API the warning pertains to.  The content of the
+   directive should be written in complete sentences and include all appropriate
+   punctuation.  This should only be chosen over ``note`` for information
+   regarding the possibility of crashes, data loss, or security implications.
 
 .. describe:: versionadded
 

Modified: python/branches/py3k/Doc/extending/extending.rst
==============================================================================
--- python/branches/py3k/Doc/extending/extending.rst	(original)
+++ python/branches/py3k/Doc/extending/extending.rst	Mon Apr 27 18:20:50 2009
@@ -47,7 +47,7 @@
 which pulls in the Python API (you can add a comment describing the purpose of
 the module and a copyright notice if you like).
 
-.. warning::
+.. note::
 
    Since Python may define some pre-processor definitions which affect the standard
    headers on some systems, you *must* include :file:`Python.h` before any standard

Modified: python/branches/py3k/Doc/library/2to3.rst
==============================================================================
--- python/branches/py3k/Doc/library/2to3.rst	(original)
+++ python/branches/py3k/Doc/library/2to3.rst	Mon Apr 27 18:20:50 2009
@@ -354,7 +354,7 @@
 .. moduleauthor:: Collin Winter
 
 
-.. warning::
+.. note::
 
    The :mod:`lib2to3` API should be considered unstable and may change
    drastically in the future.

Modified: python/branches/py3k/Doc/library/aifc.rst
==============================================================================
--- python/branches/py3k/Doc/library/aifc.rst	(original)
+++ python/branches/py3k/Doc/library/aifc.rst	Mon Apr 27 18:20:50 2009
@@ -1,4 +1,3 @@
-
 :mod:`aifc` --- Read and write AIFF and AIFC files
 ==================================================
 
@@ -16,10 +15,11 @@
 samples in a file.  AIFF-C is a newer version of the format that includes the
 ability to compress the audio data.
 
-.. warning::
+.. note::
 
    Some operations may only work under IRIX; these will raise :exc:`ImportError`
-   when attempting to import the :mod:`cl` module, which is only available on IRIX.
+   when attempting to import the :mod:`cl` module, which is only available on
+   IRIX.
 
 Audio files have a number of parameters that describe the audio data. The
 sampling rate or frame rate is the number of times per second the sound is

Modified: python/branches/py3k/Doc/library/codeop.rst
==============================================================================
--- python/branches/py3k/Doc/library/codeop.rst	(original)
+++ python/branches/py3k/Doc/library/codeop.rst	Mon Apr 27 18:20:50 2009
@@ -42,7 +42,7 @@
    (``'single'``, the default) or as an :term:`expression` (``'eval'``).  Any
    other value will cause :exc:`ValueError` to  be raised.
 
-   .. warning::
+   .. note::
 
       It is possible (but not likely) that the parser stops parsing with a
       successful outcome before reaching the end of the source; in this case,

Modified: python/branches/py3k/Doc/library/configparser.rst
==============================================================================
--- python/branches/py3k/Doc/library/configparser.rst	(original)
+++ python/branches/py3k/Doc/library/configparser.rst	Mon Apr 27 18:20:50 2009
@@ -21,10 +21,10 @@
 can use this to write Python programs which can be customized by end users
 easily.
 
-.. warning::
+.. note::
 
-   This library does *not* interpret or write the value-type prefixes used in the
-   Windows Registry extended version of INI syntax.
+   This library does *not* interpret or write the value-type prefixes used in
+   the Windows Registry extended version of INI syntax.
 
 The configuration file consists of sections, led by a ``[section]`` header and
 followed by ``name: value`` entries, with continuations in the style of

Modified: python/branches/py3k/Doc/library/fileinput.rst
==============================================================================
--- python/branches/py3k/Doc/library/fileinput.rst	(original)
+++ python/branches/py3k/Doc/library/fileinput.rst	Mon Apr 27 18:20:50 2009
@@ -144,7 +144,7 @@
 it is deleted when the output file is closed.  In-place filtering is disabled
 when standard input is read.
 
-.. warning::
+.. note::
 
    The current implementation does not work for MS-DOS 8+3 filesystems.
 

Modified: python/branches/py3k/Doc/library/functions.rst
==============================================================================
--- python/branches/py3k/Doc/library/functions.rst	(original)
+++ python/branches/py3k/Doc/library/functions.rst	Mon Apr 27 18:20:50 2009
@@ -359,7 +359,7 @@
       global and local dictionary, respectively, which may be useful to pass around
       for use as the second and third argument to :func:`exec`.
 
-   .. warning::
+   .. note::
 
       The default *locals* act as described for function :func:`locals` below:
       modifications to the default *locals* dictionary should not be attempted.
@@ -591,7 +591,7 @@
 
    Update and return a dictionary representing the current local symbol table.
 
-   .. warning::
+   .. note::
 
       The contents of this dictionary should not be modified; changes may not affect
       the values of local variables used by the interpreter.
@@ -1166,7 +1166,7 @@
    else that has a :attr:`__dict__` attribute), returns a dictionary corresponding
    to the object's symbol table.
 
-   .. warning::
+   .. note::
       The returned dictionary should not be modified:
       the effects on the corresponding symbol table are undefined. [#]_
 

Modified: python/branches/py3k/Doc/library/http.client.rst
==============================================================================
--- python/branches/py3k/Doc/library/http.client.rst	(original)
+++ python/branches/py3k/Doc/library/http.client.rst	Mon Apr 27 18:20:50 2009
@@ -52,9 +52,9 @@
    formatted file that contains your private key. *cert_file* is a PEM formatted
    certificate chain file.
 
-   .. warning::
+   .. note::
 
-      This does not do any certificate verification!
+      This does not do any certificate verification.
 
 
 .. class:: HTTPResponse(sock[, debuglevel=0][, strict=0])

Modified: python/branches/py3k/Doc/library/inspect.rst
==============================================================================
--- python/branches/py3k/Doc/library/inspect.rst	(original)
+++ python/branches/py3k/Doc/library/inspect.rst	Mon Apr 27 18:20:50 2009
@@ -455,7 +455,7 @@
 the function name, a list of lines of context from the source code, and the
 index of the current line within that list.
 
-.. warning::
+.. note::
 
    Keeping references to frame objects, as found in the first element of the frame
    records these functions return, can cause your program to create reference

Modified: python/branches/py3k/Doc/library/locale.rst
==============================================================================
--- python/branches/py3k/Doc/library/locale.rst	(original)
+++ python/branches/py3k/Doc/library/locale.rst	Mon Apr 27 18:20:50 2009
@@ -377,7 +377,7 @@
 
    Return name of the n-th day of the week.
 
-   .. warning::
+   .. note::
 
       This follows the US convention of :const:`DAY_1` being Sunday, not the
       international convention (ISO 8601) that Monday is the first day of the week.
@@ -413,7 +413,7 @@
    Return a regular expression that can be used with the regex function to
    recognize a positive response to a yes/no question.
 
-   .. warning::
+   .. note::
 
       The expression is in the syntax suitable for the :cfunc:`regex` function from
       the C library, which might differ from the syntax used in :mod:`re`.

Modified: python/branches/py3k/Doc/library/marshal.rst
==============================================================================
--- python/branches/py3k/Doc/library/marshal.rst	(original)
+++ python/branches/py3k/Doc/library/marshal.rst	Mon Apr 27 18:20:50 2009
@@ -73,7 +73,7 @@
    file must be an open file object opened in binary mode (``'rb'`` or
    ``'r+b'``).
 
-   .. warning::
+   .. note::
 
       If an object containing an unsupported type was marshalled with :func:`dump`,
       :func:`load` will substitute ``None`` for the unmarshallable type.

Modified: python/branches/py3k/Doc/library/os.path.rst
==============================================================================
--- python/branches/py3k/Doc/library/os.path.rst	(original)
+++ python/branches/py3k/Doc/library/os.path.rst	Mon Apr 27 18:20:50 2009
@@ -23,12 +23,11 @@
    their parameters.  The result is an object of the same type, if a path or
    file name is returned.
 
-.. warning::
+.. note::
 
    On Windows, many of these functions do not properly support UNC pathnames.
    :func:`splitunc` and :func:`ismount` do handle them correctly.
 
-
 .. note::
 
    Since different operating systems have different path name conventions, there
@@ -288,6 +287,33 @@
    *unc* will always be the empty string. Availability:  Windows.
 
 
+<<<<<<< .working
+=======
+.. function:: walk(path, visit, arg)
+
+   Calls the function *visit* with arguments ``(arg, dirname, names)`` for each
+   directory in the directory tree rooted at *path* (including *path* itself, if it
+   is a directory).  The argument *dirname* specifies the visited directory, the
+   argument *names* lists the files in the directory (gotten from
+   ``os.listdir(dirname)``). The *visit* function may modify *names* to influence
+   the set of directories visited below *dirname*, e.g. to avoid visiting certain
+   parts of the tree.  (The object referred to by *names* must be modified in
+   place, using :keyword:`del` or slice assignment.)
+
+   .. note::
+
+      Symbolic links to directories are not treated as subdirectories, and that
+      :func:`walk` therefore will not visit them. To visit linked directories you must
+      identify them with ``os.path.islink(file)`` and ``os.path.isdir(file)``, and
+      invoke :func:`walk` as necessary.
+
+   .. note::
+
+      This function is deprecated and has been removed in 3.0 in favor of
+      :func:`os.walk`.
+
+
+>>>>>>> .merge-right.r72009
 .. data:: supports_unicode_filenames
 
    True if arbitrary Unicode strings can be used as file names (within limitations

Modified: python/branches/py3k/Doc/library/pickle.rst
==============================================================================
--- python/branches/py3k/Doc/library/pickle.rst	(original)
+++ python/branches/py3k/Doc/library/pickle.rst	Mon Apr 27 18:20:50 2009
@@ -66,8 +66,8 @@
 .. warning::
 
    The :mod:`pickle` module is not intended to be secure against erroneous or
-   maliciously constructed data.  Never unpickle data received from an untrusted or
-   unauthenticated source.
+   maliciously constructed data.  Never unpickle data received from an untrusted
+   or unauthenticated source.
 
 Note that serialization is a more primitive notion than persistence; although
 :mod:`pickle` reads and writes file objects, it does not handle the issue of
@@ -437,6 +437,7 @@
 the methods :meth:`__getstate__` and :meth:`__setstate__`.
 
 .. note::
+
    At unpickling time, some methods like :meth:`__getattr__`,
    :meth:`__getattribute__`, or :meth:`__setattr__` may be called upon the
    instance.  In case those methods rely on some internal invariant being

Modified: python/branches/py3k/Doc/library/string.rst
==============================================================================
--- python/branches/py3k/Doc/library/string.rst	(original)
+++ python/branches/py3k/Doc/library/string.rst	Mon Apr 27 18:20:50 2009
@@ -1,4 +1,3 @@
-
 :mod:`string` --- Common string operations
 ==========================================
 

Modified: python/branches/py3k/Doc/library/subprocess.rst
==============================================================================
--- python/branches/py3k/Doc/library/subprocess.rst	(original)
+++ python/branches/py3k/Doc/library/subprocess.rst	Mon Apr 27 18:20:50 2009
@@ -321,10 +321,10 @@
 
 .. warning::
 
-   Use :meth:`communicate` rather than :meth:`.stdin.write`,
-   :meth:`.stdout.read` or :meth:`.stderr.read` to avoid deadlocks due
-   to any of the other OS pipe buffers filling up and blocking the child
-   process.
+   Use :meth:`communicate` rather than :attr:`.stdin.write <stdin>`,
+   :attr:`.stdout.read <stdout>` or :attr:`.stderr.read <stderr>` to avoid
+   deadlocks due to any of the other OS pipe buffers filling up and blocking the
+   child process.
 
 
 .. attribute:: Popen.stdin

Modified: python/branches/py3k/Doc/library/tabnanny.rst
==============================================================================
--- python/branches/py3k/Doc/library/tabnanny.rst	(original)
+++ python/branches/py3k/Doc/library/tabnanny.rst	Mon Apr 27 18:20:50 2009
@@ -1,4 +1,3 @@
-
 :mod:`tabnanny` --- Detection of ambiguous indentation
 ======================================================
 
@@ -14,9 +13,9 @@
 is possible to import it into an IDE and use the function :func:`check`
 described below.
 
-.. warning::
+.. note::
 
-   The API provided by this module is likely to change  in future releases; such
+   The API provided by this module is likely to change in future releases; such
    changes may not be backward compatible.
 
 

Modified: python/branches/py3k/Doc/library/unittest.rst
==============================================================================
--- python/branches/py3k/Doc/library/unittest.rst	(original)
+++ python/branches/py3k/Doc/library/unittest.rst	Mon Apr 27 18:20:50 2009
@@ -1085,7 +1085,7 @@
       creates an instance of the class for each test method defined for the
       class.
 
-      .. warning::
+      .. note::
 
          While using a hierarchy of :class:`TestCase`\ -derived classes can be
          convenient in sharing fixtures and helper functions, defining test

Modified: python/branches/py3k/Doc/reference/compound_stmts.rst
==============================================================================
--- python/branches/py3k/Doc/reference/compound_stmts.rst	(original)
+++ python/branches/py3k/Doc/reference/compound_stmts.rst	Mon Apr 27 18:20:50 2009
@@ -186,7 +186,7 @@
 emulate the effect of Pascal's ``for i := a to b do``; e.g., ``range(3)``
 returns the list ``[0, 1, 2]``.
 
-.. warning::
+.. note::
 
    .. index::
       single: loop; over mutable sequence

Modified: python/branches/py3k/Doc/reference/executionmodel.rst
==============================================================================
--- python/branches/py3k/Doc/reference/executionmodel.rst	(original)
+++ python/branches/py3k/Doc/reference/executionmodel.rst	Mon Apr 27 18:20:50 2009
@@ -222,7 +222,7 @@
 the instance or a base class thereof.  The instance can be received by the
 handler and can carry additional information about the exceptional condition.
 
-.. warning::
+.. note::
 
    Exception messages are not part of the Python API.  Their contents may change
    from one version of Python to the next without warning and should not be
