Clarify which refs can be used when

Clarify that refpaths are for unmerged changes in Gerrit and hexsha refs
are for merged commits.

Change-Id: Ib963c3b1a03c1e2751e0661ed7961697670fe190
This commit is contained in:
Lev Morgan 2019-03-27 12:33:03 -05:00
parent e3e5683765
commit 3da63c306b
1 changed files with 4 additions and 2 deletions

View File

@ -45,8 +45,10 @@ def git_handler(repo_url,
Supported ``ref`` formats include:
* branch name (e.g. 'master')
* refpath (e.g. 'refs/changes/54/457754/73')
* hexsha (e.g. 'ff5496b9c781918fdc49d79f927323eeef2f5320')
* refpath, for unmerged changes in Gerrit (e.g.
'refs/changes/54/457754/73')
* hexsha, for merged commits (e.g.
'ff5496b9c781918fdc49d79f927323eeef2f5320')
:param repo_url: URL of remote Git repo or path to local Git repo. If no
local copy exists, clone it. Afterward, check out ``ref`` in the repo.