bpo-38899: virtual environment activation for fish should use `source` (GH-17359)

The previously documented use of `.` is considered deprecated (https://fishshell.com/docs/current/commands.html#source).

https://bugs.python.org/issue38899

Automerge-Triggered-By: @brettcannon

diff --git a/Doc/using/venv-create.inc b/Doc/using/venv-create.inc
index cf5af437d6aee4267725771bdb235840f69d332c..6c6617dc158f7e30245c3669922e579ba9457e32 100644 (file)
--- a/Doc/using/venv-create.inc
+++ b/Doc/using/venv-create.inc
@@ -104,7 +104,7 @@ directory containing the virtual environment):
 +=============+=================+=========================================+
 | POSIX       | bash/zsh        | $ source <venv>/bin/activate            |
 +-------------+-----------------+-----------------------------------------+
-|             | fish            | $ . <venv>/bin/activate.fish            |
+|             | fish            | $ source <venv>/bin/activate.fish       |
 +-------------+-----------------+-----------------------------------------+
 |             | csh/tcsh        | $ source <venv>/bin/activate.csh        |
 +-------------+-----------------+-----------------------------------------+

diff --git a/Lib/venv/scripts/posix/activate.fish b/Lib/venv/scripts/posix/activate.fish
index 777d51cb69b0cc0a5250eaea3e8c8b2bb45fb895..d213b9060a6872e65e8686f45c91f54651221741 100644 (file)
--- a/Lib/venv/scripts/posix/activate.fish
+++ b/Lib/venv/scripts/posix/activate.fish
@@ -1,5 +1,5 @@
-# This file must be used with ". bin/activate.fish" *from fish* (http://fishshell.org);
-# you cannot run it directly.
+# This file must be used with "source <venv>/bin/activate.fish" *from fish*
+# (http://fishshell.org); you cannot run it directly.
 
 function deactivate  -d "Exit virtualenv and return to normal shell environment"
     # reset old environment variables

diff --git a/Misc/NEWS.d/next/Documentation/2019-11-22-15-57-29.bpo-38899.4aYPW2.rst b/Misc/NEWS.d/next/Documentation/2019-11-22-15-57-29.bpo-38899.4aYPW2.rst
new file mode 100644 (file)
index 0000000..4ee178b
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2019-11-22-15-57-29.bpo-38899.4aYPW2.rst
@@ -0,0 +1,3 @@
+Update documentation to state that to activate virtual environments under
+fish one should use `source`, not `.` as documented at
+https://fishshell.com/docs/current/commands.html#source.