mirrors/git
0
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-11-29 04:54:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: 'trailers' is the preferred way to format trailers

Browse Source 
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>
This commit is contained in:
Taylor Blau 2017-10-01 22:25:20 -07:00 committed by Junio C Hamano
parent 6f5c77a119
commit 85cd4bb319
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/git-for-each-ref.txt
View File

@ -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`).