From 99b64ba80f71ba2c7059546cdf175cc82749808a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul=20=28ACSONE=29?= Date: Sat, 18 May 2019 11:57:41 +0200 Subject: [PATCH] docs: mention installing from git refs --- docs/html/reference/pip_install.rst | 3 ++- news/6512.doc | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 news/6512.doc diff --git a/docs/html/reference/pip_install.rst b/docs/html/reference/pip_install.rst index 2f24677d4..cc38f0bd7 100644 --- a/docs/html/reference/pip_install.rst +++ b/docs/html/reference/pip_install.rst @@ -392,11 +392,12 @@ Here are the supported forms:: [-e] git+file:///home/user/projects/MyProject#egg=MyProject -e git+git@git.example.com:MyProject#egg=MyProject -Passing branch names, a commit hash or a tag name is possible like so:: +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 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/6512.doc b/news/6512.doc new file mode 100644 index 000000000..25a5dfa53 --- /dev/null +++ b/news/6512.doc @@ -0,0 +1 @@ +Mention that pip can install from git refs.