From: Junio C Hamano <gitster@pobox.com>
Date: Wed, 23 Aug 2017 21:13:14 +0000 (-0700)
Subject: Merge branch 'mg/format-ref-doc-fix'
X-Git-Tag: v2.15.0-rc0~141
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/883bac8f7ff1a3e11b65d44813e945543989471f?ds=inline;hp=-c

Merge branch 'mg/format-ref-doc-fix'

Doc fix.

* mg/format-ref-doc-fix:
Documentation/git-for-each-ref: clarify peeling of tags for --format
Documentation: use proper wording for ref format strings
---

883bac8f7ff1a3e11b65d44813e945543989471f
diff --combined Documentation/git-for-each-ref.txt
index cc42c12832,e8772e532c..bb370c9c7b
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@@ -38,11 -38,12 +38,12 @@@ OPTION
  	key.
  
  <format>::
- 	A string that interpolates `%(fieldname)` from the
- 	object pointed at by a ref being shown.  If `fieldname`
+ 	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
- 	at a tag object, the value for the field in the object
- 	tag refers is used.  When unspecified, defaults to
+ 	at a tag object, use the value for the field in the object
+ 	which the tag object refers to (instead of the field in the tag object).
+ 	When unspecified, `<format>` defaults to
  	`%(objectname) SPC %(objecttype) TAB %(refname)`.
  	It also interpolates `%%` to `%`, and `%xx` where `xx`
  	are hex digits interpolates to character with hex code
@@@ -156,10 -157,8 +157,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
diff --combined Documentation/git-tag.txt
index d97aad3439,32410f3d22..543fb425ee
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@@ -188,8 -188,8 +188,8 @@@ This option is only applicable when lis
  	Defaults to HEAD.
  
  <format>::
- 	A string that interpolates `%(fieldname)` from the object
- 	pointed at by a ref being shown.  The format is the same as
+ 	A string that interpolates `%(fieldname)` from a tag ref being shown
+ 	and the object it points at.  The format is the same as
  	that of linkgit:git-for-each-ref[1].  When unspecified,
  	defaults to `%(refname:strip=2)`.
  
@@@ -205,9 -205,6 +205,9 @@@ it in the repository configuration as f
      signingKey = <gpg-keyid>
  -------------------------------------
  
 +`pager.tag` is only respected when listing tags, i.e., when `-l` is
 +used or implied. The default is to use a pager.
 +See linkgit:git-config[1].
  
  DISCUSSION
  ----------