Merge branch 'mg/format-ref-doc-fix' into next
authorJunio C Hamano <gitster@pobox.com>
Sun, 20 Aug 2017 06:07:23 +0000 (23:07 -0700)
committerJunio C Hamano <gitster@pobox.com>
Sun, 20 Aug 2017 06:07:23 +0000 (23:07 -0700)
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

1  2 
Documentation/git-for-each-ref.txt
Documentation/git-tag.txt
index cc42c128323d32bd1a9bf47688722321857a5d65,e8772e532c0c4a5aefd9232fdc057045d6d58289..bb370c9c7b91425ad939383d8b28c5fbbb73cbac
@@@ -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
index d97aad3439a9f5a64ca6c808b10906610ac47a94,32410f3d22f0a7961d99854599ea1d5b86e03e07..543fb425ee7c1d4c09a5ad4afbd00b9b812e4871
@@@ -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
  ----------