[PATCH] Documentation update for 'git branch --list'
- From
Vincent van Ravesteijn <vfr@lyx.org>
- Date
- Nov 21, 2011, 14:33 UTC
- Message-ID
- <1321886000-4163-1-git-send-email-vfr@lyx.org>
Indicate that the <pattern>... argument is only valid when using --list. Otherwise a branch with the name <pattern> will be created. The current synopsis also suggests that 'git branch -d <pattern>...' would be a valid command.
Minor changes: - add a period to a sentence, - change tag into branch.
Signed-off-by: Vincent van Ravesteijn <vfr@lyx.org> --- Documentation/git-branch.txt | 11 ++++++----- 1 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index f46013c..9f49db4 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -9,8 +9,9 @@ SYNOPSIS -------- [verse] 'git branch' [--color[=<when>] | --no-color] [-r | -a] - [--list] [-v [--abbrev=<length> | --no-abbrev]] - [(--merged | --no-merged | --contains) [<commit>]] [<pattern>...] + [-v [--abbrev=<length> | --no-abbrev]] + [(--merged | --no-merged | --contains) [<commit>]] + [--list [<pattern>...]] 'git branch' [--set-upstream | --track | --no-track] [-l] [-f] <branchname> [<start-point>] 'git branch' (-m | -M) [<oldbranch>] <newbranch> 'git branch' (-d | -D) [-r] <branchname>... @@ -23,8 +24,8 @@ be highlighted with an asterisk. Option `-r` causes the remote-tracking branches to be listed, and option `-a` shows both. This list mode is also activated by the `--list` option (see below). <pattern> restricts the output to matching branches, the pattern is a shell -wildcard (i.e., matched using fnmatch(3)) -Multiple patterns may be given; if any of them matches, the tag is shown. +wildcard (i.e., matched using fnmatch(3)). +Multiple patterns may be given; if any of them matches, the branch is shown. With `--contains`, shows only the branches that contain the named commit (in other words, the branches whose tip commits are descendants of the @@ -114,7 +115,7 @@ OPTIONS --all:: List both remote-tracking branches and local branches. ---list:: +--list [<pattern>...]:: Activate the list mode. `git branch <pattern>` would try to create a branch, use `git branch --list <pattern>` to list matching branches.
-- 1.7.4.1