path: root/Documentation/git-for-each-ref.txt
diff options
authorJunio C Hamano <>2017-08-23 21:13:14 (GMT)
committerJunio C Hamano <>2017-08-23 21:13:15 (GMT)
commit883bac8f7ff1a3e11b65d44813e945543989471f (patch)
tree928f0909e02849ebfb65459dca018f258afb3e1a /Documentation/git-for-each-ref.txt
parent4add209e2c1f31c25297a5610f6720d7504001d5 (diff)
parent794b7e1674671093cf01b7b0f4467c9ba83e7c11 (diff)
Merge branch 'mg/format-ref-doc-fix'
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
Diffstat (limited to 'Documentation/git-for-each-ref.txt')
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index cc42c12..bb370c9 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -38,11 +38,12 @@ OPTIONS
- 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