]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Merge branch 'ab/branch-list-doc'
authorJunio C Hamano <gitster@pobox.com>
Tue, 28 Mar 2017 21:05:59 +0000 (14:05 -0700)
committerJunio C Hamano <gitster@pobox.com>
Tue, 28 Mar 2017 21:05:59 +0000 (14:05 -0700)
Doc update.

* ab/branch-list-doc:
  branch doc: update description for `--list`
  branch doc: change `git branch <pattern>` to use `<branchname>`

Documentation/git-branch.txt

index 092f1bcf9f89f124a2d3c80eadeab5b4a63db941..c203e8c07352f0f5efcb47bab376c4e03ad44e24 100644 (file)
@@ -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 <pattern>` 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::