summaryrefslogtreecommitdiff
path: root/Documentation/git-for-each-ref.txt
diff options
context:
space:
mode:
authorMichael J Gruber <git@grubix.eu>2017-08-18 14:51:23 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-08-18 16:54:10 (GMT)
commit794b7e1674671093cf01b7b0f4467c9ba83e7c11 (patch)
treef77907bb44dfa81b412e96bcbb2eb519cf23a359 /Documentation/git-for-each-ref.txt
parente4933cee53bce14ae040d02d0febd678c5686dde (diff)
downloadgit-794b7e1674671093cf01b7b0f4467c9ba83e7c11.zip
git-794b7e1674671093cf01b7b0f4467c9ba83e7c11.tar.gz
git-794b7e1674671093cf01b7b0f4467c9ba83e7c11.tar.bz2
Documentation/git-for-each-ref: clarify peeling of tags for --format
`*` in format strings means peeling of tag objects so that object field names refer to the object that the tag object points at, instead of the tag object itself. Currently, this is documented using grammar that is clearly inspired by classical latin, though missing more than an article in order to be classical english. Try and straighten that explanation out a bit. Signed-off-by: Michael J Gruber <git@grubix.eu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-for-each-ref.txt')
-rw-r--r--Documentation/git-for-each-ref.txt5
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index f9fa8fa..e8772e5 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -41,8 +41,9 @@ OPTIONS
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