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>`

1  2 
Documentation/git-branch.txt
index 092f1bcf9f89f124a2d3c80eadeab5b4a63db941,514b0d0b9110450ac7c79e023291d824e26f0302..c203e8c07352f0f5efcb47bab376c4e03ad44e24
@@@ -12,7 -12,7 +12,7 @@@ SYNOPSI
        [--list] [-v [--abbrev=<length> | --no-abbrev]]
        [--column[=<options>] | --no-column]
        [(--merged | --no-merged | --contains) [<commit>]] [--sort=<key>]
 -      [--points-at <object>] [<pattern>...]
 +      [--points-at <object>] [--format=<format>] [<pattern>...]
  'git branch' [--set-upstream | --track | --no-track] [-l] [-f] <branchname> [<start-point>]
  'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>]
  'git branch' --unset-upstream [<branchname>]
@@@ -142,8 -142,13 +142,13 @@@ This option is only applicable in non-v
        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::
@@@ -253,11 -258,6 +258,11 @@@ start-point is either a local or remote
  --points-at <object>::
        Only list branches of the given object.
  
 +--format <format>::
 +      A string that interpolates `%(fieldname)` from the object
 +      pointed at by a ref being shown.  The format is the same as
 +      that of linkgit:git-for-each-ref[1].
 +
  Examples
  --------