[PATCH 2/2] Documentation/git-for-each-ref: clarify peeling of tags for --format
- From
Michael J Gruber <git@grubix.eu>
- Date
- Aug 18, 2017, 14:51 UTC
- Message-ID
- <45e7986107a8e8b2f87891c729be8e13043670f3.1503067851.git.git@grubix.eu>
- In-Reply-To
- <35df94bc16d9b1436d2110f5d5c54732e5d9a619.1503067851.git.git@grubix.eu>
`*` 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> --- Documentation/git-for-each-ref.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt index dac9138fab..bb370c9c7b 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
-- 2.14.1.224.g15ee91971c