summaryrefslogtreecommitdiffstats
path: root/Doc/using/venv-create.inc
diff options
context:
space:
mode:
authorSteve Dower <steve.dower@microsoft.com>2019-01-30 21:49:14 (GMT)
committerGitHub <noreply@github.com>2019-01-30 21:49:14 (GMT)
commita1f9a3332bd4767e47013ea787022f06b6dbcbbd (patch)
tree7953193c5c6971eb5168b8ca753449615a5a8ce5 /Doc/using/venv-create.inc
parent40ebe948e97b47fc84c8f527910063286a174b25 (diff)
downloadcpython-a1f9a3332bd4767e47013ea787022f06b6dbcbbd.zip
cpython-a1f9a3332bd4767e47013ea787022f06b6dbcbbd.tar.gz
cpython-a1f9a3332bd4767e47013ea787022f06b6dbcbbd.tar.bz2
bpo-35854: Fix EnvBuilder and --symlinks in venv on Windows (GH-11700)
Diffstat (limited to 'Doc/using/venv-create.inc')
-rw-r--r--Doc/using/venv-create.inc5
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/using/venv-create.inc b/Doc/using/venv-create.inc
index ba5096a..1ba538b 100644
--- a/Doc/using/venv-create.inc
+++ b/Doc/using/venv-create.inc
@@ -70,6 +70,11 @@ The command, if run with ``-h``, will show the available options::
In earlier versions, if the target directory already existed, an error was
raised, unless the ``--clear`` or ``--upgrade`` option was provided.
+.. note::
+ While symlinks are supported on Windows, they are not recommended. Of
+ particular note is that double-clicking ``python.exe`` in File Explorer
+ will resolve the symlink eagerly and ignore the virtual environment.
+
The created ``pyvenv.cfg`` file also includes the
``include-system-site-packages`` key, set to ``true`` if ``venv`` is
run with the ``--system-site-packages`` option, ``false`` otherwise.