Skip to content

Commit

Permalink
Clarification on removed urls
Browse files Browse the repository at this point in the history
  • Loading branch information
deveshks committed Mar 31, 2020
1 parent 6fbf80a commit ee33761
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
12 changes: 8 additions & 4 deletions docs/html/reference/pip_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -402,9 +402,13 @@ Git
^^^

pip currently supports cloning over ``git``, ``git+http``, ``git+https``,
``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.`_)
``git+ssh``, ``git+git`` and ``git+file``.

.. warning::

Note that the ``git``, ``git+git``,and ``git+http`` are not recommended.
(The former two use `the Git Protocol`_. which lacks authentication, and HTTP is
insecure due to lack of TLS based encryption)

Here are the supported forms::

Expand All @@ -424,7 +428,7 @@ 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
.. _`the Git Protocol`: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols

Mercurial
^^^^^^^^^
Expand Down
3 changes: 2 additions & 1 deletion news/1983.doc
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Remove VCS URLs pertaining to the Git protocol from docs
Emphasize that VCS URLs using ``git``, ``git+git`` and ``git+http`` are insecure due to
lack of authentication and encryption

0 comments on commit ee33761

Please sign in to comment.