Merge pull request #6512 from sbidoul/git-ref-doc

docs: mention installing from git refs
pypa · May 18, 2019 · c966484 · c966484
2 parents 6387867 + 99b64ba
commit c966484
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git 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 [email protected]: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/[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
 
 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
@@ -0,0 +1 @@
+Mention that pip can install from git refs.