From: Christian Couder <christian.couder@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Jeff King <peff@peff.net>,
Christian Couder <chriscool@tuxfamily.org>
Subject: [PATCH v2 1/2] Documentation: clarify %(contents:XXXX) doc
Date: Thu, 2 Jul 2020 16:08:44 +0200 [thread overview]
Message-ID: <20200702140845.24945-2-chriscool@tuxfamily.org> (raw)
In-Reply-To: <20200702140845.24945-1-chriscool@tuxfamily.org>
Let's avoid a big dense paragraph by using an unordered
list for the %(contents:XXXX) format specifiers.
Suggested-by: Jeff King <peff@peff.net>
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
Documentation/git-for-each-ref.txt | 24 ++++++++++++++++++------
1 file changed, 18 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 6dcd39f6f6..2db9779d54 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -232,12 +232,24 @@ 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 complete message of a commit or tag object is `contents`. This
+field can also be used in the following ways:
+
+contents:subject::
+ The "subject" of the commit or tag message. It's actually the
+ concatenation of all lines of the commit message up to the
+ first blank line.
+
+contents:body::
+ The "body" of the commit or tag message. It's made of the
+ lines after the first blank line.
+
+contents:signature::
+ The optional GPG signature.
+
+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
--
2.27.0.221.ga08a83db2b.dirty
next prev parent reply other threads:[~2020-07-02 14:09 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-02 14:08 [PATCH v2 0/2] Add support for %(contents:size) in ref-filter Christian Couder
2020-07-02 14:08 ` Christian Couder [this message]
2020-07-06 21:34 ` [PATCH v2 1/2] Documentation: clarify %(contents:XXXX) doc Junio C Hamano
2020-07-02 14:08 ` [PATCH v2 2/2] ref-filter: add support for %(contents:size) Christian Couder
2020-07-06 21:44 ` Junio C Hamano
2020-07-07 8:40 ` Christian Couder
2020-07-07 15:28 ` Junio C Hamano
2020-07-07 5:02 ` [PATCH v2 0/2] Add support for %(contents:size) in ref-filter Jeff King
2020-07-07 6:19 ` Christian Couder
2020-07-08 4:43 ` Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200702140845.24945-2-chriscool@tuxfamily.org \
--to=christian.couder@gmail.com \
--cc=chriscool@tuxfamily.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).