summaryrefslogtreecommitdiffstats
path: root/git-for-each-ref.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2020-07-30 14:22:26 -0700
committerJunio C Hamano <gitster@pobox.com>2020-07-30 14:22:26 -0700
commit28c33dede604b6d79be8b63ca9a53401cb3187f5 (patch)
treea17257ac77fcf56175733532e3d358a5b6db16ce /git-for-each-ref.txt
parent2196da6c492fcd776cf9209d6537235b75a58a3a (diff)
downloadgit-htmldocs-28c33dede604b6d79be8b63ca9a53401cb3187f5.tar.gz
Autogenerated HTML docs for v2.28.0-67-g79bcaf
Diffstat (limited to 'git-for-each-ref.txt')
-rw-r--r--git-for-each-ref.txt27
1 files changed, 21 insertions, 6 deletions
diff --git a/git-for-each-ref.txt b/git-for-each-ref.txt
index 6dcd39f6f..2ea71c5f6 100644
--- a/git-for-each-ref.txt
+++ b/git-for-each-ref.txt
@@ -232,12 +232,27 @@ Fields that have name-email-date tuple as its value (`author`,
`committer`, and `tagger`) can be suffixed with `name`, `email`,
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
-blank line. The optional GPG signature is `contents:signature`. The
-first `N` lines of the message is obtained using `contents:lines=N`.
+The message in a commit or a tag object is `contents`, from which
+`contents:<part>` can be used to extract various parts out of:
+
+contents:size::
+ The size in bytes of the commit or tag message.
+
+contents:subject::
+ The first paragraph of the message, which typically is a
+ single line, is taken as the "subject" of the commit or the
+ tag message.
+
+contents:body::
+ The remainder of the commit or the tag message that follows
+ the "subject".
+
+contents:signature::
+ The optional GPG signature of the tag.
+
+contents:lines=N::
+ The first `N` lines of the message.
+
Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1]
are obtained as `trailers` (or by using the historical alias
`contents:trailers`). Non-trailer lines from the trailer block can be omitted