Git development
 help / color / mirror / Atom feed
From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>,
	christian.couder@gmail.com, jackmanb@google.com,
	Linus Arver <linus@ucla.edu>,
	"D . Ben Knoble" <ben.knoble@gmail.com>,
	Matt Hunter <m@lfurio.us>, Junio C Hamano <gitster@pobox.com>
Subject: [PATCH v4 10/11] doc: interpret-trailers: rewrite new-trailers paragraphs
Date: Thu, 30 Jul 2026 11:18:23 +0200	[thread overview]
Message-ID: <V4_rewrite_new-trailers.aec@msgid.xyz> (raw)
In-Reply-To: <V4_CV_doc_int-tr_key_format.ae2@msgid.xyz>

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Two commits ago we moved new-trailers paragraph next to each other.
But there is something curious about two of them:

    By default the new trailer will appear at the end of the trailer
    block. [...]

Then a source block and a paragraph later:

    By default, a `<key>=<value>` or `<key>:<value>` argument given
    using `--trailer` will be appended after the existing trailers only
    if [...]

Why are there two paragraphs that talk about how “By default” a trailer
will be appended?

We can make these paragraphs flow better, and with a more distinct
character each, by dividing the flow like this:

1. Declare that we are about to talk about `--trailer` appending
2. Explain the default behavior
3. Explain how this affects the trailer block
4. Then discuss what each trailer line will look like

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---

Notes (series):
    v4:
    • Simplify “This is how the new trailer” paragraph: drop “More
      concretely,” since it is misleading (this is not a “more
      concretely continuation of the preceding paragraph(s))[1]
    
      🔗 1: https://lore.kernel.org/git/xmqqcxxyt4op.fsf@gitster.g/
    
    ---
    
    v3: [new]
    • Based on draft: https://lore.kernel.org/git/fc1f8149-98c2-48e5-9725-08cc21696cb2@app.fastmail.com/
    • See msg:
    
          Two commits ago we moved new-trailers paragraph next to
          each other.
    
      This commit here might fit better one step back. So that it
      becomes the commit right after. But I can deal with that commit
      movement if this change is accepted. For now I didn’t bother.

 Documentation/git-interpret-trailers.adoc | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/Documentation/git-interpret-trailers.adoc b/Documentation/git-interpret-trailers.adoc
index a1adab20fef..ac59ef51f80 100644
--- a/Documentation/git-interpret-trailers.adoc
+++ b/Documentation/git-interpret-trailers.adoc
@@ -60,10 +60,18 @@ are applied to each input and the way any existing trailer in
 the input is changed. They also make it possible to
 automatically add some trailers.
 
-By default, a `<key>=<value>` or `<key>:<value>` argument given
-using `--trailer` will be appended after the existing trailers only if
-the last trailer has a different (_<key>_, _<value>_) pair (or if there
-is no existing trailer). The _<key>_ and _<value>_ parts will be trimmed
+Let's consider new trailers added with `--trailer`.
+By default, the new trailer will appear at the end of the trailer block.
+Also by default, this new trailer will only be added
+if the last trailer is different to it.
+A trailer block will be created with only that trailer if a trailer
+block does not already exist. Recall that a trailer block needs to be
+preceded by a blank line, so a blank line will be inserted before the
+new trailer block in that case.
+
+This is how the new trailer is added: a `<key>=<value>` or
+`<key>:<value>` argument given using `--trailer` will be appended after
+the existing trailers. The _<key>_ and _<value>_ parts will be trimmed
 to remove starting and trailing whitespace, and the resulting trimmed
 _<key>_ and _<value>_ will appear in the output like this:
 
@@ -74,12 +82,6 @@ key: value
 This means that the trimmed _<key>_ and _<value>_ will be separated by
 "`:`{nbsp}" (one colon followed by one space).
 
-By default the new trailer will appear at the end of the trailer block.
-A trailer block will be created with only that trailer if a trailer
-block does not already exist. Recall that a trailer block needs to be
-preceded by a blank line, so a blank line will be inserted before the
-new trailer block in that case.
-
 Existing trailers are extracted from the input by looking for the
 trailer block. A trailer block is a group of one or more lines that (i)
 is all trailers, or (ii) contains at least one Git-generated or
-- 
2.54.0.22.g9e26862b904


  parent reply	other threads:[~2026-07-30  9:21 UTC|newest]

Thread overview: 69+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-01 13:27 git-interpret-trailers and period characters in the key Brendan Jackman
2025-04-03 11:07 ` Christian Couder
2025-04-07 20:37   ` Junio C Hamano
2026-03-30 21:11 ` [PATCH 0/2] doc: interpret-trailers: explain key format kristofferhaugsbakk
2026-03-30 21:11   ` [PATCH 1/2] doc: interpret-trailers: stop fixating on RFC 822 kristofferhaugsbakk
2026-03-30 22:27     ` Junio C Hamano
2026-03-30 22:56       ` Kristoffer Haugsbakk
2026-03-30 23:24         ` Junio C Hamano
2026-03-30 21:11   ` [PATCH 2/2] doc: interpret-trailers: explain key format kristofferhaugsbakk
2026-03-30 21:55     ` Junio C Hamano
2026-03-30 22:23       ` Kristoffer Haugsbakk
2026-03-31 12:35         ` Ben Knoble
2026-03-31 16:03           ` Kristoffer Haugsbakk
2026-04-13 10:20   ` [PATCH v2 0/9] " kristofferhaugsbakk
2026-04-13 10:21     ` [PATCH v2 1/9] doc: interpret-trailers: stop fixating on RFC 822 kristofferhaugsbakk
2026-04-13 10:21     ` [PATCH v2 2/9] doc: interpret-trailers: replace “lines” with “metadata” kristofferhaugsbakk
2026-04-13 10:21     ` [PATCH v2 3/9] doc: interpret-trailers: use “metadata” in Name as well kristofferhaugsbakk
2026-04-13 10:21     ` [PATCH v2 4/9] doc: interpret-trailers: not just for commit messages kristofferhaugsbakk
2026-04-13 10:21     ` [PATCH v2 5/9] doc: interpret-trailers: explain the format after the intro kristofferhaugsbakk
2026-04-13 10:21     ` [PATCH v2 6/9] doc: interpret-trailers: explain key format kristofferhaugsbakk
2026-04-13 10:21     ` [PATCH v2 7/9] doc: interpret-trailers: add key format example kristofferhaugsbakk
2026-04-13 10:21     ` [PATCH v2 8/9] doc: interpret-trailers: commit to “trailer block” term kristofferhaugsbakk
2026-04-13 10:21     ` [PATCH v2 9/9] doc: intepret-trailers: document comment line treatment kristofferhaugsbakk
2026-04-13 13:26       ` Kristoffer Haugsbakk
2026-04-13 15:48         ` Junio C Hamano
2026-05-08 15:03           ` Kristoffer Haugsbakk
2026-05-08 15:01     ` [PATCH v2 0/9] doc: interpret-trailers: explain key format Kristoffer Haugsbakk
2026-05-11  2:41       ` Junio C Hamano
2026-05-11 19:23         ` D. Ben Knoble
2026-05-24 12:41           ` Kristoffer Haugsbakk
2026-05-26 21:34             ` Ben Knoble
2026-05-26 21:42               ` Kristoffer Haugsbakk
2026-05-26 21:45                 ` Kristoffer Haugsbakk
2026-06-10 21:21   ` [PATCH v3 00/11] " kristofferhaugsbakk
2026-06-10 21:21     ` [PATCH v3 01/11] doc: interpret-trailers: stop fixating on RFC 822 kristofferhaugsbakk
2026-06-10 21:21     ` [PATCH v3 02/11] doc: interpret-trailers: replace “lines” with “metadata” kristofferhaugsbakk
2026-06-11  3:10       ` Matt Hunter
2026-06-16 20:32         ` Kristoffer Haugsbakk
2026-06-16 21:39           ` Matt Hunter
2026-06-10 21:21     ` [PATCH v3 03/11] doc: interpret-trailers: use “metadata” in Name as well kristofferhaugsbakk
2026-06-10 21:21     ` [PATCH v3 04/11] doc: interpret-trailers: not just for commit messages kristofferhaugsbakk
2026-06-10 21:21     ` [PATCH v3 05/11] doc: interpret-trailers: explain the format after the intro kristofferhaugsbakk
2026-06-10 21:21     ` [PATCH v3 06/11] doc: interpret-trailers: explain key format kristofferhaugsbakk
2026-06-10 21:21     ` [PATCH v3 07/11] doc: interpret-trailers: add key format example kristofferhaugsbakk
2026-06-10 21:21     ` [PATCH v3 08/11] doc: interpret-trailers: join new-trailers again kristofferhaugsbakk
2026-06-10 22:00       ` D. Ben Knoble
2026-06-10 22:13         ` Kristoffer Haugsbakk
2026-06-10 21:21     ` [PATCH v3 09/11] doc: interpret-trailers: commit to “trailer block” term kristofferhaugsbakk
2026-06-10 21:21     ` [PATCH v3 10/11] doc: interpret-trailers: rewrite new-trailers paragraphs kristofferhaugsbakk
2026-06-10 21:21     ` [PATCH v3 11/11] doc: interpret-trailers: document comment line treatment kristofferhaugsbakk
2026-06-10 22:24     ` [PATCH v3 00/11] doc: interpret-trailers: explain key format Junio C Hamano
2026-06-11 11:57       ` Junio C Hamano
2026-06-11 12:05         ` Kristoffer Haugsbakk
2026-06-11 12:53           ` Kristoffer Haugsbakk
2026-06-17 19:45       ` Kristoffer Haugsbakk
2026-07-23 23:48         ` Junio C Hamano
2026-07-30  9:20           ` Kristoffer Haugsbakk
2026-07-30  9:18   ` [PATCH v4 " kristofferhaugsbakk
2026-07-30  9:18     ` [PATCH v4 01/11] doc: interpret-trailers: stop fixating on RFC 822 kristofferhaugsbakk
2026-07-30  9:18     ` [PATCH v4 02/11] doc: interpret-trailers: replace “lines” with “metadata” kristofferhaugsbakk
2026-07-30  9:18     ` [PATCH v4 03/11] doc: interpret-trailers: use “metadata” in Name as well kristofferhaugsbakk
2026-07-30  9:18     ` [PATCH v4 04/11] doc: interpret-trailers: not just for commit messages kristofferhaugsbakk
2026-07-30  9:18     ` [PATCH v4 05/11] doc: interpret-trailers: explain the format after the intro kristofferhaugsbakk
2026-07-30  9:18     ` [PATCH v4 06/11] doc: interpret-trailers: explain key format kristofferhaugsbakk
2026-07-30  9:18     ` [PATCH v4 07/11] doc: interpret-trailers: add key format example kristofferhaugsbakk
2026-07-30  9:18     ` [PATCH v4 08/11] doc: interpret-trailers: join new-trailers again kristofferhaugsbakk
2026-07-30  9:18     ` [PATCH v4 09/11] doc: interpret-trailers: commit to “trailer block” term kristofferhaugsbakk
2026-07-30  9:18     ` kristofferhaugsbakk [this message]
2026-07-30  9:18     ` [PATCH v4 11/11] doc: interpret-trailers: document comment line treatment kristofferhaugsbakk

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=V4_rewrite_new-trailers.aec@msgid.xyz \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=ben.knoble@gmail.com \
    --cc=christian.couder@gmail.com \
    --cc=code@khaugsbakk.name \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jackmanb@google.com \
    --cc=linus@ucla.edu \
    --cc=m@lfurio.us \
    /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