summaryrefslogtreecommitdiff
path: root/Doc/using
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-02-22 03:14:08 -0800
committerGitHub <noreply@github.com>2019-02-22 03:14:08 -0800
commit1b2ff9ff093ab315f691348a0e91094bfa2056a0 (patch)
treec94eba22677b87ce26da9b05525adf3b5650a7ae /Doc/using
parent22bfe637ca7728e9f74d4dc8bb7a15ee2a913815 (diff)
downloadcpython-git-1b2ff9ff093ab315f691348a0e91094bfa2056a0.tar.gz
Include the --prompt flag in venv's help output (GH-10711)
Document usage of the existing `--prompt` option in the command line help. (cherry picked from commit 3208880f1c72800bacf94a2045fcb0436702c7a1) Co-authored-by: Holger Frey <socials@holgerfrey.de>
Diffstat (limited to 'Doc/using')
-rw-r--r--Doc/using/venv-create.inc4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/using/venv-create.inc b/Doc/using/venv-create.inc
index 1ba538bec4..1ada83c07a 100644
--- a/Doc/using/venv-create.inc
+++ b/Doc/using/venv-create.inc
@@ -35,7 +35,7 @@ your :ref:`Python installation <using-on-windows>`::
The command, if run with ``-h``, will show the available options::
usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
- [--upgrade] [--without-pip]
+ [--upgrade] [--without-pip] [--prompt PROMPT]
ENV_DIR [ENV_DIR ...]
Creates virtual Python environments in one or more target directories.
@@ -58,6 +58,8 @@ The command, if run with ``-h``, will show the available options::
of Python, assuming Python has been upgraded in-place.
--without-pip Skips installing or upgrading pip in the virtual
environment (pip is bootstrapped by default)
+ --prompt PROMPT Provides an alternative prompt prefix for this
+ environment.
Once an environment has been created, you may wish to activate it, e.g. by
sourcing an activate script in its bin directory.