Skip to content

Commit 794b7e1

Browse files
mjggitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e4933ce commit 794b7e1

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Documentation/git-for-each-ref.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ OPTIONS
4141
A string that interpolates `%(fieldname)` from a ref being shown
4242
and the object it points at. If `fieldname`
4343
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
4647
`%(objectname) SPC %(objecttype) TAB %(refname)`.
4748
It also interpolates `%%` to `%`, and `%xx` where `xx`
4849
are hex digits interpolates to character with hex code

0 commit comments

Comments
 (0)