summaryrefslogtreecommitdiff
path: root/Doc/using
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-01-30 14:14:35 -0800
committerGitHub <noreply@github.com>2019-01-30 14:14:35 -0800
commit03082a836b707528f885080bda9732d89849d4e3 (patch)
treead00775765bfcf04c60b5ebc30806c203b427596 /Doc/using
parente31f8604e692c46800abd70f88d9928fa1f17b7c (diff)
downloadcpython-git-03082a836b707528f885080bda9732d89849d4e3.tar.gz
bpo-35854: Fix EnvBuilder and --symlinks in venv on Windows (GH-11700)
(cherry picked from commit a1f9a3332bd4767e47013ea787022f06b6dbcbbd) Co-authored-by: Steve Dower <steve.dower@microsoft.com>
Diffstat (limited to 'Doc/using')
-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 ba5096abd3..1ba538bec4 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.