From 6fbf80a9f9ba031a188737454bf90c1607cce99f 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 | 16 +++++++++------- news/1983.doc | 1 + 2 files changed, 10 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 bd61151d7..6600693ca 100644 --- a/docs/html/reference/pip_install.rst +++ b/docs/html/reference/pip_install.rst @@ -402,28 +402,30 @@ 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``, ``git+git``, +and ``git+http`` are not recommended due to their lack of security. +(The former two uses `the Git Protocol.`_) 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 making fewer network calls). +.. _`the Git Protocol.`: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols + Mercurial ^^^^^^^^^ diff --git a/news/1983.doc b/news/1983.doc new file mode 100644 index 000000000..58b85ac1f --- /dev/null +++ b/news/1983.doc @@ -0,0 +1 @@ +Remove VCS URLs pertaining to the Git protocol from docs