Skip to content

Commit

Permalink
Remove vcs urls pertaining to git protocol from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
deveshks committed Mar 30, 2020
1 parent 019637c commit 99fe5c1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/html/reference/pip_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]#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/[email protected]#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
Expand Down
1 change: 1 addition & 0 deletions news/1983.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Remove VCS URLs pertaining to the Git protocol from docs

0 comments on commit 99fe5c1

Please sign in to comment.