Skip to content

Commit 9fcc9ca

Browse files
chriscoolgitster
authored andcommitted
Documentation: clarify %(contents:XXXX) doc
Let's avoid a big dense paragraph by using an unordered list for the %(contents:XXXX) format specifiers. While at it let's also make the following improvements: - Let's not describe %(contents) using "complete message" as it's not clear what an incomplete message is. - Let's improve how the "subject" and "body" are described. - Let's state that "signature" is only available for tag objects. Suggested-by: Jeff King <[email protected]> Signed-off-by: Christian Couder <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 4a0fcf9 commit 9fcc9ca

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

Documentation/git-for-each-ref.txt

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -232,12 +232,24 @@ Fields that have name-email-date tuple as its value (`author`,
232232
`committer`, and `tagger`) can be suffixed with `name`, `email`,
233233
and `date` to extract the named component.
234234

235-
The complete message in a commit and tag object is `contents`.
236-
Its first line is `contents:subject`, where subject is the concatenation
237-
of all lines of the commit message up to the first blank line. The next
238-
line is `contents:body`, where body is all of the lines after the first
239-
blank line. The optional GPG signature is `contents:signature`. The
240-
first `N` lines of the message is obtained using `contents:lines=N`.
235+
The message in a commit or a tag object is `contents`, from which
236+
`contents:<part>` can be used to extract various parts out of:
237+
238+
contents:subject::
239+
The first paragraph of the message, which typically is a
240+
single line, is taken as the "subject" of the commit or the
241+
tag message.
242+
243+
contents:body::
244+
The remainder of the commit or the tag message that follows
245+
the "subject".
246+
247+
contents:signature::
248+
The optional GPG signature of the tag.
249+
250+
contents:lines=N::
251+
The first `N` lines of the message.
252+
241253
Additionally, the trailers as interpreted by linkgit:git-interpret-trailers[1]
242254
are obtained as `trailers` (or by using the historical alias
243255
`contents:trailers`). Non-trailer lines from the trailer block can be omitted

0 commit comments

Comments
 (0)