From 99fe5c17cbbd26969781b3ff049c54ee43f953ec Mon Sep 17 00:00:00 2001 From: Devesh Kumar Singh Date: Mon, 30 Mar 2020 15:54:02 +0530 Subject: [PATCH] Remove vcs urls pertaining to git protocol from docs --- docs/html/reference/pip_install.rst | 13 ++++++------- news/1983.doc | 1 + 2 files changed, 7 insertions(+), 7 deletions(-) create mode 100644 news/1983.doc diff --git a/docs/html/reference/pip_install.rst b/docs/html/reference/pip_install.rst index bd61151d712..a69293049a9 100644 --- a/docs/html/reference/pip_install.rst +++ b/docs/html/reference/pip_install.rst @@ -402,23 +402,22 @@ Git ^^^ pip currently supports cloning over ``git``, ``git+http``, ``git+https``, -``git+ssh``, ``git+git`` and ``git+file``: +``git+ssh``, ``git+git`` and ``git+file``, but note that the ``git`` and ``git+git`` +are based on the Git protocol which are not recommended due to their lack of security.: Here are the supported forms:: - [-e] git://git.example.com/MyProject#egg=MyProject [-e] git+http://git.example.com/MyProject#egg=MyProject [-e] git+https://git.example.com/MyProject#egg=MyProject [-e] git+ssh://git.example.com/MyProject#egg=MyProject - [-e] git+git://git.example.com/MyProject#egg=MyProject [-e] git+file:///home/user/projects/MyProject#egg=MyProject Passing a branch name, a commit hash, a tag name or a git ref is possible like so:: - [-e] git://git.example.com/MyProject.git@master#egg=MyProject - [-e] git://git.example.com/MyProject.git@v1.0#egg=MyProject - [-e] git://git.example.com/MyProject.git@da39a3ee5e6b4b0d3255bfef95601890afd80709#egg=MyProject - [-e] git://git.example.com/MyProject.git@refs/pull/123/head#egg=MyProject + [-e] git+https://git.example.com/MyProject.git@master#egg=MyProject + [-e] git+https://git.example.com/MyProject.git@v1.0#egg=MyProject + [-e] git+https://git.example.com/MyProject.git@da39a3ee5e6b4b0d3255bfef95601890afd80709#egg=MyProject + [-e] git+https://git.example.com/MyProject.git@refs/pull/123/head#egg=MyProject When passing a commit hash, specifying a full hash is preferable to a partial hash because a full hash allows pip to operate more efficiently (e.g. by diff --git a/news/1983.doc b/news/1983.doc new file mode 100644 index 00000000000..58b85ac1fe2 --- /dev/null +++ b/news/1983.doc @@ -0,0 +1 @@ +Remove VCS URLs pertaining to the Git protocol from docs