mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: clarify git-branch --list behavior

Browse Source 
It was not clear from the "description" section of git-branch(1)
that using a <pattern> meant that you _had_ to use the --list
option. Let's clarify that, and while we're at it, reword some
clunky and ambiguous sentences.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jeff King
2013-01-31 01:45:46 -05:00
committed by Junio C Hamano
parent 045e3884bc
commit de90ff81f3
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/git-branch.txt
View File

@ -22,13 +22,15 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
----------- -----------
With no arguments, existing branches are listed and the current branch will If `--list` is given, or if there are no non-option arguments, existing
be highlighted with an asterisk. Option `-r` causes the remote-tracking branches are listed; the current branch will be highlighted with an
branches to be listed, and option `-a` shows both. This list mode is also asterisk. Option `-r` causes the remote-tracking branches to be listed,
activated by the `--list` option (see below). and option `-a` shows both local and remote branches. If a `<pattern>`
<pattern> restricts the output to matching branches, the pattern is a shell is given, it is used as a shell wildcard to restrict the output to
wildcard (i.e., matched using fnmatch(3)). matching branches. If multiple patterns are given, a branch is shown if
Multiple patterns may be given; if any of them matches, the branch is shown. it matches any of the patterns. Note that when providing a
`<pattern>`, you must use `--list`; otherwise the command is interpreted
as branch creation.
With `--contains`, shows only the branches that contain the named commit With `--contains`, shows only the branches that contain the named commit
(in other words, the branches whose tip commits are descendants of the (in other words, the branches whose tip commits are descendants of the