[Python-checkins] cpython (merge 3.3 -> default): Closes #18433: Merged documentation update from 3.3.

[vinay.sajip]

http://hg.python.org/cpython/rev/d292635314c9
changeset:   84598:d292635314c9
parent:      84596:b4650f08735f
parent:      84597:0ca31c07e85e
user:        Vinay Sajip <vinay_sajip at yahoo.co.uk>
date:        Fri Jul 12 21:54:12 2013 +0100
summary:
  Closes #18433: Merged documentation update from 3.3.

files:
  Doc/library/venv.rst |  13 ++++++++++---
  1 files changed, 10 insertions(+), 3 deletions(-)


diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst
--- a/Doc/library/venv.rst
+++ b/Doc/library/venv.rst
@@ -124,11 +124,13 @@
         :meth:`create_configuration`, :meth:`setup_python`,
         :meth:`setup_scripts` and :meth:`post_setup` can be overridden.
 
-    .. method:: create_directories(env_dir)
+    .. method:: ensure_directories(env_dir)
 
         Creates the environment directory and all necessary directories, and
         returns a context object.  This is just a holder for attributes (such as
-        paths), for use by the other methods.
+        paths), for use by the other methods. The directories are allowed to
+        exist already, as long as either ``clear`` or ``upgrade`` were
+        specified to allow operating on an existing environment directory.
 
     .. method:: create_configuration(context)
 
@@ -137,7 +139,10 @@
     .. method:: setup_python(context)
 
         Creates a copy of the Python executable (and, under Windows, DLLs) in
-        the environment.
+        the environment. On a POSIX system, if a specific executable
+        ``python3.x`` was used, symlinks to ``python`` and ``python3`` will be
+        created pointing to that executable, unless files with those names
+        already exist.
 
     .. method:: setup_scripts(context)
 
@@ -174,6 +179,8 @@
         * ``__VENV_PYTHON__`` is replaced with the absolute path of the
           environment's executable.
 
+        The directories are allowed to exist (for when an existing environment
+        is being upgraded).
 
 There is also a module-level convenience function:
 

-- 
Repository URL: http://hg.python.org/cpython