summaryrefslogtreecommitdiffstats
path: root/Doc/library/venv.rst
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2012-05-29 11:52:14 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2012-05-29 11:52:14 (GMT)
commit4126a7dc17cf15167cccd76dc49f348fb560b255 (patch)
tree20daa805cfc62435d510c99a1bac02ff851cefe4 /Doc/library/venv.rst
parentecdc076695bbe138a456a359c168c19e8e3de147 (diff)
downloadcpython-4126a7dc17cf15167cccd76dc49f348fb560b255.zip
cpython-4126a7dc17cf15167cccd76dc49f348fb560b255.tar.gz
cpython-4126a7dc17cf15167cccd76dc49f348fb560b255.tar.bz2
Added pyvenv docs to 'Python Setup and Usage' section.
Diffstat (limited to 'Doc/library/venv.rst')
-rw-r--r--Doc/library/venv.rst9
1 files changed, 4 insertions, 5 deletions
diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst
index b86f573..7f81281 100644
--- a/Doc/library/venv.rst
+++ b/Doc/library/venv.rst
@@ -54,7 +54,7 @@ or equivalently::
The command, if run with ``-h``, will show the available options::
usage: pyvenv [-h] [--system-site-packages] [--symlink] [--clear]
- ENV_DIR [ENV_DIR ...]
+ [--upgrade] ENV_DIR [ENV_DIR ...]
Creates virtual Python environments in one or more target directories.
@@ -69,12 +69,11 @@ The command, if run with ``-h``, will show the available options::
--clear Delete the environment directory if it already exists.
If not specified and the directory exists, an error is
raised.
-
+ --upgrade Upgrade the environment directory to use this version
+ of Python, assuming Python has been upgraded in-place.
If the target directory already exists an error will be raised, unless
-the ``--clear`` option was provided, in which case the target
-directory will be deleted and virtual environment creation will
-proceed as usual.
+the ``--clear`` or ``--upgrade`` option was provided.
The created ``pyvenv.cfg`` file also includes the
``include-system-site-packages`` key, set to ``true`` if ``venv`` is