diff options
| author |  SZEDER Gábor <szeder.dev@gmail.com> | 2017-02-03 03:48:09 +0100 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2017-02-03 22:18:39 -0800 |
| commit | be6fbdb5459dcd685b308e49b2855e2f54120e19 (patch) | |
| tree | 6013898a49b028928b7b90014428260b9fb85fea /contrib/completion | |
| parent | Git 2.12-rc0 (diff) | |
| download | tgif-be6fbdb5459dcd685b308e49b2855e2f54120e19.tar.xz | |
completion: improve __git_refs()'s in-code documentation
That "first argument is passed to __gitdir()" statement in particular
is not really helpful, and after this series it won't be the case
anyway.
Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'contrib/completion')
| -rw-r--r-- | contrib/completion/git-completion.bash | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash index 97d73ad88f..a43322b04a 100644 --- a/contrib/completion/git-completion.bash +++ b/contrib/completion/git-completion.bash @@ -332,9 +332,11 @@ __git_tags () fi } -# __git_refs accepts 0, 1 (to pass to __gitdir), or 2 arguments -# presence of 2nd argument means use the guess heuristic employed -# by checkout for tracking branches +# Lists refs from the local (by default) or from a remote repository. +# It accepts 0, 1 or 2 arguments: +# 1: The remote to list refs from (optional; ignored, if set but empty). +# 2: In addition to local refs, list unique branches from refs/remotes/ for +# 'git checkout's tracking DWIMery (optional; ignored, if set but empty). __git_refs () { local i hash dir="$(__gitdir "${1-}")" track="${2-}" |