diff options
author | Philip Oakley <philipoakley@iee.org> | 2019-05-29 00:16:05 +0100 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2019-05-29 10:36:16 -0700 |
commit | 1fde99cfc766353237ff1ca4829ba8d71ccebc87 (patch) | |
tree | 8e575f488435104638130bd4bf6ec3ccdc4bf4b0 /builtin/branch.c | |
parent | mingw: allow building with an MSYS2 runtime v3.x (diff) | |
download | tgif-1fde99cfc766353237ff1ca4829ba8d71ccebc87.tar.xz |
doc branch: provide examples for listing remote tracking branches
The availability of these pattern selections is not obvious from
the man pages, as per mail thread <87lfz3vcbt.fsf@evledraar.gmail.com>.
Provide examples.
Re-order the `git branch` synopsis to emphasise the `--list <pattern>`
pairing. Also expand and reposition the `all/remotes` options.
Split the over-long description into three parts so that the <pattern>
description can be seen.
Clarify that the `all/remotes` options require the --list if patterns
are to be used.
Add examples of listing remote tracking branches that match a pattern,
including `git for-each-ref` which has more options.
Improve the -a/-r warning message. The message confused this author
as the combined -a and -r options had not been given, though a pattern
had. Specifically guide the user that maybe they needed the --list
option to enable a remote branch pattern selection.
Signed-off-by: Philip Oakley <philipoakley@iee.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'builtin/branch.c')
-rw-r--r-- | builtin/branch.c | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/builtin/branch.c b/builtin/branch.c index 1be727209b..30906d4526 100644 --- a/builtin/branch.c +++ b/builtin/branch.c @@ -810,7 +810,8 @@ int cmd_branch(int argc, const char **argv, const char *prefix) strbuf_release(&buf); } else if (argc > 0 && argc <= 2) { if (filter.kind != FILTER_REFS_BRANCHES) - die(_("-a and -r options to 'git branch' do not make sense with a branch name")); + die(_("The -a, and -r, options to 'git branch' do not take a branch name.\n" + "Did you mean to use: -a|-r --list <pattern>?")); if (track == BRANCH_TRACK_OVERRIDE) die(_("the '--set-upstream' option is no longer supported. Please use '--track' or '--set-upstream-to' instead.")); |