traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Issue #26034: Sync documentation of --clear with its behavior 

Most of the docs has already been updated in c3c188a0325a.
This commit is contained in:
Berker Peksag 2016-01-28 09:01:49 +02:00
parent 0fe1b472ab 547f66f599
commit 1b95517337
2 changed files with 8 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Doc/using/venv-create.inc
View File

@ -45,9 +45,8 @@ The command, if run with ``-h``, will show the available options::
are not the default for the platform. are not the default for the platform.
--copies Try to use copies rather than symlinks, even when --copies Try to use copies rather than symlinks, even when
symlinks are the default for the platform. symlinks are the default for the platform.
--clear Delete the environment directory if it already exists. --clear Delete the contents of the environment directory if it
If not specified and the directory exists, an error is already exists, before environment creation.
raised.
--upgrade Upgrade the environment directory to use this version --upgrade Upgrade the environment directory to use this version
of Python, assuming Python has been upgraded in-place. of Python, assuming Python has been upgraded in-place.
--without-pip Skips installing or upgrading pip in the virtual --without-pip Skips installing or upgrading pip in the virtual

15
Lib/venv/__init__.py
View File

@ -19,9 +19,8 @@ optional arguments:
Give the virtual environment access to the system Give the virtual environment access to the system
site-packages dir. site-packages dir.
--symlinks Attempt to symlink rather than copy. --symlinks Attempt to symlink rather than copy.
--clear Delete the environment directory if it already exists. --clear Delete the contents of the environment directory if it
If not specified and the directory exists, an error is already exists, before environment creation.
raised.
--upgrade Upgrade the environment directory to use this version --upgrade Upgrade the environment directory to use this version
of Python, assuming Python has been upgraded in-place. of Python, assuming Python has been upgraded in-place.
--without-pip Skips installing or upgrading pip in the virtual --without-pip Skips installing or upgrading pip in the virtual
@ -52,9 +51,8 @@ class EnvBuilder:
:param system_site_packages: If True, the system (global) site-packages :param system_site_packages: If True, the system (global) site-packages
dir is available to created environments. dir is available to created environments.
:param clear: If True and the target directory exists, it is deleted. :param clear: Delete the contents of the environment directory if it
Otherwise, if the target directory exists, an error is already exists, before environment creation.
raised.
:param symlinks: If True, attempt to symlink rather than copy files into :param symlinks: If True, attempt to symlink rather than copy files into
virtual environment. virtual environment.
:param upgrade: If True, upgrade an existing virtual environment. :param upgrade: If True, upgrade an existing virtual environment.
@ -361,9 +359,8 @@ def create(env_dir, system_site_packages=False, clear=False,
:param env_dir: The target directory to create an environment in. :param env_dir: The target directory to create an environment in.
:param system_site_packages: If True, the system (global) site-packages :param system_site_packages: If True, the system (global) site-packages
dir is available to the environment. dir is available to the environment.
:param clear: If True and the target directory exists, it is deleted. :param clear: Delete the contents of the environment directory if it
Otherwise, if the target directory exists, an error is already exists, before environment creation.
raised.
:param symlinks: If True, attempt to symlink rather than copy files into :param symlinks: If True, attempt to symlink rather than copy files into
virtual environment. virtual environment.
:param with_pip: If True, ensure pip is installed in the virtual :param with_pip: If True, ensure pip is installed in the virtual