cpython: 5764cc02244d (original) (raw)

Mercurial > cpython

changeset 100084:5764cc02244d

Issue #26034: Sync documentation of --clear with its behavior Most of the docs has already been updated in c3c188a0325a. [#26034]

Berker Peksag berker.peksag@gmail.com
date	Thu, 28 Jan 2016 09:01:49 +0200
parents	7c38a47fd4d5(current diff)d2a32b78be96(diff)
children	0fb96a43d381
files
diffstat	2 files changed, 8 insertions(+), 12 deletions(-)[+] [-] Doc/using/venv-create.inc 5 Lib/venv/__init__.py 15

line wrap: on

line diff

--- a/Doc/using/venv-create.inc +++ b/Doc/using/venv-create.inc @@ -45,9 +45,8 @@ The command, if run with -h, will sh are not the default for the platform. --copies Try to use copies rather than symlinks, even when symlinks are the default for the platform.

 --clear                Delete the environment directory if it already exists.[](#l1.7)

                        If not specified and the directory exists, an error is[](#l1.8)

                        raised.[](#l1.9)

 --clear                Delete the contents of the environment directory if it[](#l1.10)

                        already exists, before environment creation.[](#l1.11)
 --upgrade              Upgrade the environment directory to use this version[](#l1.12)
                        of Python, assuming Python has been upgraded in-place.[](#l1.13)
 --without-pip          Skips installing or upgrading pip in the virtual[](#l1.14)

--- a/Lib/venv/init.py +++ b/Lib/venv/init.py @@ -19,9 +19,8 @@ optional arguments: Give the virtual environment access to the system site-packages dir. --symlinks Attempt to symlink rather than copy.

--clear Delete the environment directory if it already exists.

                   If not specified and the directory exists, an error is[](#l2.8)

```
                   raised.[](#l2.9)
```

--clear Delete the contents of the environment directory if it
```
                   already exists, before environment creation.[](#l2.11)
```
--upgrade Upgrade the environment directory to use this version of Python, assuming Python has been upgraded in-place. --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 dir is available to created environments.

:param clear: If True and the target directory exists, it is deleted.

             Otherwise, if the target directory exists, an error is[](#l2.20)

```
             raised.[](#l2.21)
```

:param clear: Delete the contents of the environment directory if it
```
             already exists, before environment creation.[](#l2.23)
```
:param symlinks: If True, attempt to symlink rather than copy files into virtual environment. :param upgrade: If True, upgrade an existing virtual environment. @@ -361,9 +359,8 @@ def create(env_dir, system_site_packages :param env_dir: The target directory to create an environment in. :param system_site_packages: If True, the system (global) site-packages dir is available to the environment.

:param clear: If True and the target directory exists, it is deleted.

             Otherwise, if the target directory exists, an error is[](#l2.32)

```
             raised.[](#l2.33)
```

:param clear: Delete the contents of the environment directory if it
```
             already exists, before environment creation.[](#l2.35)
```
:param symlinks: If True, attempt to symlink rather than copy files into virtual environment. :param with_pip: If True, ensure pip is installed in the virtual