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>
Taylor Blau committed
Oct 1, 2017 at 22:25 UTC
85cd4bb319605e3a18f08242d49562ffb3729123
1 file changed
+2
-1
Documentation/git-for-each-ref.txt
+2
-1
@@ -217,7 +217,8 @@ line is 'contents:body', where body is all of the lines after the first
217
blank line. The optional GPG signature is `contents:signature`. The
218
first `N` lines of the message is obtained using `contents:lines=N`.
219
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').
222
223
For sorting purposes, fields with numeric values sort in numeric order
224
(`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`).