From 1fde99cfc766353237ff1ca4829ba8d71ccebc87 Mon Sep 17 00:00:00 2001 From: Philip Oakley Date: Wed, 29 May 2019 00:16:05 +0100 Subject: 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 ` pairing. Also expand and reposition the `all/remotes` options. Split the over-long description into three parts so that the 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 Signed-off-by: Junio C Hamano --- builtin/branch.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'builtin/branch.c') 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 ?")); if (track == BRANCH_TRACK_OVERRIDE) die(_("the '--set-upstream' option is no longer supported. Please use '--track' or '--set-upstream-to' instead.")); -- cgit v1.2.3