summaryrefslogtreecommitdiff
path: root/Documentation/git-branch.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-03-24 04:17:00 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-03-24 17:15:49 (GMT)
commit75ec4a6cb0921688d01a7e7800a5dd5d9f1ad586 (patch)
tree10342c1a5385aa98c7372389678ac7e467983624 /Documentation/git-branch.txt
parentb66f3b6bba3a4e0210f8d63ce456f3055c8aa85d (diff)
downloadgit-75ec4a6cb0921688d01a7e7800a5dd5d9f1ad586.zip
git-75ec4a6cb0921688d01a7e7800a5dd5d9f1ad586.tar.gz
git-75ec4a6cb0921688d01a7e7800a5dd5d9f1ad586.tar.bz2
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.txt9
1 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 6a17ca5..514b0d0 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::