diff options
| author | Junio C Hamano <gitster@pobox.com> | 2017-03-24 07:17:00 +0300 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-03-24 20:15:49 +0300 |
| commit | 75ec4a6cb0921688d01a7e7800a5dd5d9f1ad586 (patch) | |
| tree | 10342c1a5385aa98c7372389678ac7e467983624 /Documentation/git-branch.txt | |
| parent | b66f3b6bba3a4e0210f8d63ce456f3055c8aa85d (diff) | |
branch doc: update description for `--list`
The paragraph begins with a sample command line `git branch <name>`
that has nothing to do with the option being described. Remove it,
but use the space to instead show that multiple patterns can be
given.
Also mention the unfortunate `-l` that can be easily confused with
it.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Reviewed-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-branch.txt')
| -rw-r--r-- | Documentation/git-branch.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 6a17ca591a..514b0d0b91 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -142,8 +142,13 @@ This option is only applicable in non-verbose mode. List both remote-tracking branches and local branches. --list:: - Activate the list mode. `git branch <branchname>` would try to create a branch, - use `git branch --list <pattern>` to list matching branches. + List branches. With optional `<pattern>...`, e.g. `git + branch --list 'maint-*'`, list only the branches that match + the pattern(s). ++ +This should not be confused with `git branch -l <branchname>`, +which creates a branch named `<branchname>` with a reflog. +See `--create-reflog` above for details. -v:: -vv:: |