diff options
| author | SZEDER Gábor <szeder@ira.uka.de> | 2016-02-25 23:50:30 +0100 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2016-02-28 16:37:15 -0800 |
| commit | 87a213f93d9e86d36323f61dd256d242a941da3a (patch) | |
| tree | 47a8f26bfef80efb7613f39bf07481306b6a77e6 | |
| parent | f02fbc4f9433937ee0463d0342d6d7d97e1f6f1e (diff) | |
| download | git-87a213f93d9e86d36323f61dd256d242a941da3a.tar.gz | |
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@ira.uka.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -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 e3918c87e3..0e1fd778bf 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 lists 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-}" |