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>
Michael J Gruber committed
Aug 18, 2017 at 16:51 UTC
794b7e1674671093cf01b7b0f4467c9ba83e7c11
1 file changed
+3
-2
Documentation/git-for-each-ref.txt
+3
-2
@@ -41,8 +41,9 @@ OPTIONS
41
A string that interpolates `%(fieldname)` from a ref being shown
42
and the object it points at. If `fieldname`
43
is prefixed with an asterisk (`*`) and the ref points
44
- at a tag object, the value for the field in the object
45
- tag refers is used. When unspecified, defaults to
44
+ at a tag object, use the value for the field in the object
45
+ which the tag object refers to (instead of the field in the tag object).
46
+ When unspecified, `<format>` defaults to
47
`%(objectname) SPC %(objecttype) TAB %(refname)`.
48
It also interpolates `%%` to `%`, and `%xx` where `xx`
49
are hex digits interpolates to character with hex code