diff options
author | Junio C Hamano <gitster@pobox.com> | 2017-08-23 14:13:14 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2017-08-23 14:13:15 -0700 |
commit | 883bac8f7ff1a3e11b65d44813e945543989471f (patch) | |
tree | 928f0909e02849ebfb65459dca018f258afb3e1a /Documentation/git-for-each-ref.txt | |
parent | Merge branch 'sb/submodule-parallel-update' (diff) | |
parent | Documentation/git-for-each-ref: clarify peeling of tags for --format (diff) | |
download | tgif-883bac8f7ff1a3e11b65d44813e945543989471f.tar.xz |
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')
-rw-r--r-- | Documentation/git-for-each-ref.txt | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt index cc42c12832..bb370c9c7b 100644 --- a/Documentation/git-for-each-ref.txt +++ b/Documentation/git-for-each-ref.txt @@ -38,11 +38,12 @@ 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 + 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 |