From: Junio C Hamano <gitster@pobox.com>
Date: Tue, 19 Sep 2017 03:52:26 +0000 (+0900)
Subject: Merge branch 'kd/doc-for-each-ref' into next
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/993a2ae375071401b6cd61a06f74e911fd899f60?hp=-c

Merge branch 'kd/doc-for-each-ref' into next

Doc update.

* kd/doc-for-each-ref:
doc/for-each-ref: explicitly specify option names
doc/for-each-ref: consistently use '=' to between argument names and values
---

993a2ae375071401b6cd61a06f74e911fd899f60
diff --combined Documentation/git-for-each-ref.txt
index bb370c9c7b,d3a0994db2..66b4e0a405
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@@ -10,8 -10,9 +10,9 @@@ SYNOPSI
  [verse]
  'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
  		   [(--sort=<key>)...] [--format=<format>] [<pattern>...]
- 		   [--points-at <object>] [(--merged | --no-merged) [<object>]]
- 		   [--contains [<object>]] [--no-contains [<object>]]
+ 		   [--points-at=<object>]
+ 		   (--merged[=<object>] | --no-merged[=<object>])
+ 		   [--contains[=<object>]] [--no-contains[=<object>]]
  
  DESCRIPTION
  -----------
@@@ -25,19 -26,25 +26,25 @@@ host language allowing their direct eva
  
  OPTIONS
  -------
- <count>::
+ <pattern>...::
+ 	If one or more patterns are given, only refs are shown that
+ 	match against at least one pattern, either using fnmatch(3) or
+ 	literally, in the latter case matching completely or from the
+ 	beginning up to a slash.
+ 
+ --count=<count>::
  	By default the command shows all refs that match
  	`<pattern>`.  This option makes it stop after showing
  	that many refs.
  
- <key>::
+ --sort=<key>::
  	A field name to sort on.  Prefix `-` to sort in
  	descending order of the value.  When unspecified,
  	`refname` is used.  You may use the --sort=<key> option
  	multiple times, in which case the last key becomes the primary
  	key.
  
- <format>::
+ --format=<format>::
  	A string that interpolates `%(fieldname)` from a ref being shown
  	and the object it points at.  If `fieldname`
  	is prefixed with an asterisk (`*`) and the ref points
@@@ -50,12 -57,6 +57,6 @@@
  	`xx`; for example `%00` interpolates to `\0` (NUL),
  	`%09` to `\t` (TAB) and `%0a` to `\n` (LF).
  
- <pattern>...::
- 	If one or more patterns are given, only refs are shown that
- 	match against at least one pattern, either using fnmatch(3) or
- 	literally, in the latter case matching completely or from the
- 	beginning up to a slash.
- 
  --shell::
  --perl::
  --python::
@@@ -65,24 -66,24 +66,24 @@@
  	the specified host language.  This is meant to produce
  	a scriptlet that can directly be `eval`ed.
  
- --points-at <object>::
+ --points-at=<object>::
  	Only list refs which points at the given object.
  
- --merged [<object>]::
+ --merged[=<object>]::
  	Only list refs whose tips are reachable from the
  	specified commit (HEAD if not specified),
  	incompatible with `--no-merged`.
  
- --no-merged [<object>]::
+ --no-merged[=<object>]::
  	Only list refs whose tips are not reachable from the
  	specified commit (HEAD if not specified),
  	incompatible with `--merged`.
  
- --contains [<object>]::
+ --contains[=<object>]::
  	Only list refs which contain the specified commit (HEAD if not
  	specified).
  
- --no-contains [<object>]::
+ --no-contains[=<object>]::
  	Only list refs which don't contain the specified commit (HEAD
  	if not specified).
  
@@@ -157,10 -158,8 +158,10 @@@ HEAD:
  	otherwise.
  
  color::
 -	Change output color.  Followed by `:<colorname>`, where names
 -	are described in `color.branch.*`.
 +	Change output color. Followed by `:<colorname>`, where color
 +	names are described under Values in the "CONFIGURATION FILE"
 +	section of linkgit:git-config[1].  For example,
 +	`%(color:bold red)`.
  
  align::
  	Left-, middle-, or right-align the content between