summaryrefslogtreecommitdiff
path: root/Documentation/git-for-each-ref.txt
diff options
context:
space:
mode:
authorTaylor Blau <me@ttaylorr.com>2017-10-02 05:25:20 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-10-02 06:34:43 (GMT)
commit85cd4bb319605e3a18f08242d49562ffb3729123 (patch)
tree7c2052d2b397ac7022bf67c7db6cffbac9a642c3 /Documentation/git-for-each-ref.txt
parent6f5c77a1190d83f0c02b480f0e04c0dd78d954ed (diff)
downloadgit-85cd4bb319605e3a18f08242d49562ffb3729123.zip
git-85cd4bb319605e3a18f08242d49562ffb3729123.tar.gz
git-85cd4bb319605e3a18f08242d49562ffb3729123.tar.bz2
doc: 'trailers' is the preferred way to format trailers
The documentation makes reference to 'contents:trailers' as an example to dig the trailers out of a commit. 'trailers' is an unmentioned alternative, which is treated as an alias of 'contents:trailers'. Since 'trailers' is easier to type, prefer that as the designated way to dig out trailers information. Signed-off-by: Taylor Blau <me@ttaylorr.com> 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.txt3
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 66b4e0a..323ce07 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -217,7 +217,8 @@ line is 'contents:body', where body is all of the lines after the first
blank line. The optional GPG signature is `contents:signature`. The
first `N` lines of the message is obtained using `contents:lines=N`.
Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1]
-are obtained as 'contents:trailers'.
+are obtained as 'trailers' (or by using the historical alias
+'contents:trailers').
For sorting purposes, fields with numeric values sort in numeric order
(`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`).