From: Junio C Hamano <gitster@pobox.com>
Date: Tue, 28 Mar 2017 21:05:59 +0000 (-0700)
Subject: Merge branch 'ab/branch-list-doc'
X-Git-Tag: v2.13.0-rc0~56
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/e779b0f0703d1e85e35b2772ae458e89eca0f0d3?hp=-c

Merge branch 'ab/branch-list-doc'

Doc update.

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

e779b0f0703d1e85e35b2772ae458e89eca0f0d3
diff --combined Documentation/git-branch.txt
index 092f1bcf9f,514b0d0b91..c203e8c073
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@@ -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
  --------