path: root/Documentation/git-for-each-ref.txt
diff options
authorJunio C Hamano <>2017-10-11 05:52:22 (GMT)
committerJunio C Hamano <>2017-10-11 05:52:22 (GMT)
commitb03cd16613477d3f9ce2e82f3a9fdb5fa99a8b01 (patch)
treeeb246859d3b1a72271e5ee63bf0dacb2f123e7bf /Documentation/git-for-each-ref.txt
parent54bd705a9589d33b155588aa11d3b856f252e83d (diff)
parent7a5edbdb748f58c0ff3f2a459596ad6ddfda0640 (diff)
Merge branch 'tb/show-trailers-in-ref-filter'
"git for-each-ref --format=..." learned a new format element, %(trailers), to show only the commit log trailer part of the log message. * tb/show-trailers-in-ref-filter: ref-filter.c: parse trailers arguments with %(contents) atom ref-filter.c: use trailer_opts to format trailers t6300: refactor %(trailers) tests doc: use "`<literal>`"-style quoting for literal strings doc: 'trailers' is the preferred way to format trailers t4205: unfold across multiple lines
Diffstat (limited to 'Documentation/git-for-each-ref.txt')
1 files changed, 6 insertions, 2 deletions
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index cbd0a62..1d420e4 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -218,11 +218,15 @@ and `date` to extract the named component.
The complete message in a commit and tag object is `contents`.
Its first line is `contents:subject`, where subject is the concatenation
of all lines of the commit message up to the first blank line. The next
-line is 'contents:body', where body is all of the lines after the first
+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`). Non-trailer lines from the trailer block can be omitted
+with `trailers:only`. Whitespace-continuations can be removed from trailers so
+that each trailer appears on a line by itself with its full content with
+`trailers:unfold`. Both can be used together as `trailers:unfold,only`.
For sorting purposes, fields with numeric values sort in numeric order
(`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`).