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:22 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-08-18 16:54:09 (GMT)
commite4933cee53bce14ae040d02d0febd678c5686dde (patch)
treecdb74d59fc1ebe5ac13037da5607b05157f57070 /Documentation/git-for-each-ref.txt
parent4d7268b888d7bb6d675340ec676e4239739d0f6d (diff)
downloadgit-e4933cee53bce14ae040d02d0febd678c5686dde.zip
git-e4933cee53bce14ae040d02d0febd678c5686dde.tar.gz
git-e4933cee53bce14ae040d02d0febd678c5686dde.tar.bz2
Documentation: use proper wording for ref format strings
Various commands list refs and allow to use a format string for the output that interpolates from the ref as well as the object it points at (for-each-ref; branch and tag in list mode). Currently, the documentation talks about interpolating from the object. This is confusing because a ref points to an object but not vice versa, so the object cannot possible know %(refname), for example. Thus, this is wrong independent of refs being objects (one day, maybe) or not. Change the wording to make this clearer (and distinguish it from formats for the log family). 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.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 03e187a..f9fa8fa 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -38,8 +38,8 @@ OPTIONS
key.
<format>::
- 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