Skip to content

Commit 85cd4bb

Browse files
ttaylorrgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 6f5c77a commit 85cd4bb

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

Documentation/git-for-each-ref.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,8 @@ line is 'contents:body', where body is all of the lines after the first
217217
blank line. The optional GPG signature is `contents:signature`. The
218218
first `N` lines of the message is obtained using `contents:lines=N`.
219219
Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1]
220-
are obtained as 'contents:trailers'.
220+
are obtained as 'trailers' (or by using the historical alias
221+
'contents:trailers').
221222

222223
For sorting purposes, fields with numeric values sort in numeric order
223224
(`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`).

0 commit comments

Comments
 (0)