git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 0/9] doc: interpret-trailers: explain key format

From
Ben Knoble <ben.knoble@gmail.com>
Date
May 26, 2026, 21:34 UTC
Message-ID
<4DD440D4-145A-4A9E-ACBA-8E6ACFA231D1@gmail.com>
In-Reply-To
<fc1f8149-98c2-48e5-9725-08cc21696cb2@app.fastmail.com>
Show 8 quoted lines
> Le 24 mai 2026 à 08:41, Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com> a écrit :
> 
> On Mon, May 11, 2026, at 21:23, D. Ben Knoble wrote:
>> Overall looks good to me. Repeating a few points throughout the doc
>> might create headaches if format restrictions are changed, but I think
>> they are essential points worth repeating for now.
> 
> Thanks for taking a look again. :)
Thank you for working on it :)
Show 111 quoted lines
>>> [snip]
>>> @@ -81,19 +87,25 @@ trailer.sign.key "Signed-off-by: "
>>> in your configuration, you only need to specify `--trailer="sign: foo"`
>>> on the command line instead of `--trailer="Signed-off-by: foo"`.
>>> 
>>> -By default the new trailer will appear at the end of all the existing
>>> -trailers. If there is no existing trailer, the new trailer will appear
>>> -at the end of the input. A blank line will be added before the new
>>> -trailer if there isn't one already.
>>> +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 (specifically an empty line)
>>> +will be inserted before the new trailer block in that case.
>> 
>> [not strictly related to this patch, but while we're here…]
>> 
>> Even in context, I find the original (and new) paragraph somewhat
>> jarring. In "the new trailer," there's no antecedent for "the
>> trailer", so which new trailer are we talking about? The previous
>> paragraph is about "<key-alias>es" for --trailer="<key>: value".
>> 
>> We _could_ move this paragraph up one, so that it follows the
>> paragraph on trailers being appended when given with --trailer.
>> 
>> Either way, adjusting "the new trailer" to "a new trailer" might feel
>> better to me. Other suggestions welcome.
> 
> The paragraph about new trailers originally came right after the
> separated-by sentence:[1]
> 
>    By default, a '<token>=<value>' or '<token>:<value>' [...]
> 
>    ------------------------------------------------
>    token: value
>    ------------------------------------------------
> 
>    This means that the trimmed <token> and <value> will be separated by
>    `': '` (one colon followed by one space).
> 
>    By default the new trailer will appear [...]
> 
> † 1: dfd66ddf (Documentation: add documentation for 'git
>     interpret-trailers', 2014-10-13)
> 
> Nine years later in [2], a “For convenience, <token>” was added to that *existing paragraph:
> 
>    [...]
>    `': '` (one colon followed by one space). For convenience, the <token> can be a
>    shortened string key (e.g., "sign") instead of the full string which should
>    appear before the separator on the output (e.g., "Signed-off-by"). This can be
>    configured using the 'trailer.<token>.key' configuration variable.
> 
>    By default the new trailer will appear at the end [...]
> 
> † 2: eda2c44c (doc: trailer: mention 'key' in DESCRIPTION, 2023-06-15)
> 
> A little later in [3], that part was split into its own paragraph—and
> expanded into two more blocks (source block and paragraph):
> 
>    [...] <key> and <value> will be separated by `': '` (one colon followed
>    by one space).
> 
>    For convenience, a <keyAlias> can be configured to [...]
> 
>    ------------------------------------------------
>    key: value
>    ------------------------------------------------
> 
>    in your configuration, [...]
> 
>    By default the new trailer will appear at the end [...]
> 
> † 3: 6ccbc667 (trailer doc: <token> is a <key> or <keyAlias>, not both,
>     2023-09-07)
> 
>> We _could_ move this paragraph up one, so that it follows the
>> paragraph on trailers being appended when given with --trailer.
> 
> But going back to commit [1], there are two paragraphs that talk about
> how “By default” the new trailer will be appended to the end:
> 
>    By default, a '<token>=<value>' or '<token>:<value>' argument given
>    using `--trailer` will be appended after the existing trailers only if
>    the last trailer has a different (<token>, <value>) pair (or if there
>    is no existing trailer). The <token> and <value> parts will be trimmed
>    to remove starting and trailing whitespace, and the resulting trimmed
>    <token> and <value> will appear in the message like this:
> 
>    ------------------------------------------------
>    token: value
>    ------------------------------------------------
> 
>    This means that the trimmed <token> and <value> will be separated by
>    `': '` (one colon followed by one space).
> 
>    By default the new trailer will appear at the end of all the existing
>    trailers. If there is no existing trailer, the new trailer will appear
>    after the commit message part of the ouput, and, if there is no line
>    with only spaces at the end of the commit message part, one blank line
>    will be added before the new trailer.
> 
> These two seem to overlap? They both talk about appending. Why does one
> talk about how specifically <token>/<key> and <value> will be treated
> when appended, then a later paragraph *also* says that it will be
> appended?
> 
> Here is a draft of this part of the doc. I have tried to consolidate
> these two “By default” paragrahs and be more explicit about what “the
> trailer” is. I have included one unchanged paragraph before and after
> for context.
I’ve read through the below a few times, and I don’t really have much to add for now :) I think that’s a fine improvement.
Whether you roll that into this patch series or wait until the dust settles is up to you.
Show 39 quoted lines
> ***
> 
> Some configuration variables control the way the `--trailer` arguments
> 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.
> 
> 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 (specifically an empty line)
> will be inserted before the new trailer block in that case.
> 
> More concretely, 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:
> 
> ------------------------------------------------
> key: value
> ------------------------------------------------
> 
> This means that the trimmed _<key>_ and _<value>_ will be separated by
> "`:`{nbsp}" (one colon followed by one space).
> 
> ***
> 
>> [snip]
>>> -a group of one or more lines that (i) is all trailers, or (ii) contains at
>>> -least one Git-generated or user-configured trailer and consists of at
>>> +Existing trailers are extracted from the input by looking for the
>>> +trailer block. Concretely, that is a group of one or more lines that (i)
>>> +is all trailers, or (ii) contains at least one Git-generated or
>>> +user-configured trailer and consists of at
>>> [snip]
Previous: Kristoffer HaugsbakkNext: Kristoffer Haugsbakk
Message 31 of 90 in “git-interpret-trailers and period characters in the key”
  1. Brendan JackmanApr 1, 2025
  2. Christian CouderApr 3, 2025
  3. Junio C HamanoApr 7, 2025
  4. 0/2 doc: interpret-trailers: explain key formatkristofferhaugsbakk@fastmail.com, Mar 30, 2026
  5. 1/2 doc: interpret-trailers: stop fixating on RFC 822kristofferhaugsbakk@fastmail.com, Mar 30, 2026
  6. Junio C HamanoMar 30, 2026
  7. Kristoffer HaugsbakkMar 30, 2026
  8. Junio C HamanoMar 30, 2026
  9. 2/2 doc: interpret-trailers: explain key formatkristofferhaugsbakk@fastmail.com, Mar 30, 2026
  10. Junio C HamanoMar 30, 2026
  11. Kristoffer HaugsbakkMar 30, 2026
  12. Ben KnobleMar 31, 2026
  13. Kristoffer HaugsbakkMar 31, 2026
  14. 0/9 doc: interpret-trailers: explain key formatkristofferhaugsbakk@fastmail.com, Apr 13, 2026
  15. 1/9 doc: interpret-trailers: stop fixating on RFC 822kristofferhaugsbakk@fastmail.com, Apr 13, 2026
  16. 2/9 doc: interpret-trailers: replace “lines” with “metadata”kristofferhaugsbakk@fastmail.com, Apr 13, 2026
  17. 3/9 doc: interpret-trailers: use “metadata” in Name as wellkristofferhaugsbakk@fastmail.com, Apr 13, 2026
  18. 4/9 doc: interpret-trailers: not just for commit messageskristofferhaugsbakk@fastmail.com, Apr 13, 2026
  19. 5/9 doc: interpret-trailers: explain the format after the introkristofferhaugsbakk@fastmail.com, Apr 13, 2026
  20. 6/9 doc: interpret-trailers: explain key formatkristofferhaugsbakk@fastmail.com, Apr 13, 2026
  21. 7/9 doc: interpret-trailers: add key format examplekristofferhaugsbakk@fastmail.com, Apr 13, 2026
  22. 8/9 doc: interpret-trailers: commit to “trailer block” termkristofferhaugsbakk@fastmail.com, Apr 13, 2026
  23. 9/9 doc: intepret-trailers: document comment line treatmentkristofferhaugsbakk@fastmail.com, Apr 13, 2026
  24. Kristoffer HaugsbakkApr 13, 2026
  25. Junio C HamanoApr 13, 2026
  26. Kristoffer HaugsbakkMay 8, 2026
  27. Kristoffer HaugsbakkMay 8, 2026
  28. Junio C HamanoMay 11, 2026
  29. D. Ben KnobleMay 11, 2026
  30. Kristoffer HaugsbakkMay 24, 2026
  31. Ben KnobleMay 26, 2026
  32. Kristoffer HaugsbakkMay 26, 2026
  33. Kristoffer HaugsbakkMay 26, 2026
  34. 00/11 doc: interpret-trailers: explain key formatkristofferhaugsbakk@fastmail.com, Jun 10, 2026
  35. 01/11 doc: interpret-trailers: stop fixating on RFC 822kristofferhaugsbakk@fastmail.com, Jun 10, 2026
  36. 02/11 doc: interpret-trailers: replace “lines” with “metadata”kristofferhaugsbakk@fastmail.com, Jun 10, 2026
  37. Matt HunterJun 11, 2026
  38. Kristoffer HaugsbakkJun 16, 2026
  39. Matt HunterJun 16, 2026
  40. 03/11 doc: interpret-trailers: use “metadata” in Name as wellkristofferhaugsbakk@fastmail.com, Jun 10, 2026
  41. 04/11 doc: interpret-trailers: not just for commit messageskristofferhaugsbakk@fastmail.com, Jun 10, 2026
  42. 05/11 doc: interpret-trailers: explain the format after the introkristofferhaugsbakk@fastmail.com, Jun 10, 2026
  43. 06/11 doc: interpret-trailers: explain key formatkristofferhaugsbakk@fastmail.com, Jun 10, 2026
  44. 07/11 doc: interpret-trailers: add key format examplekristofferhaugsbakk@fastmail.com, Jun 10, 2026
  45. 08/11 doc: interpret-trailers: join new-trailers againkristofferhaugsbakk@fastmail.com, Jun 10, 2026
  46. D. Ben KnobleJun 10, 2026
  47. Kristoffer HaugsbakkJun 10, 2026
  48. 09/11 doc: interpret-trailers: commit to “trailer block” termkristofferhaugsbakk@fastmail.com, Jun 10, 2026
  49. 11/11 doc: interpret-trailers: document comment line treatmentkristofferhaugsbakk@fastmail.com, Jun 10, 2026
  50. Junio C HamanoJun 10, 2026
  51. Junio C HamanoJun 11, 2026
  52. Kristoffer HaugsbakkJun 11, 2026
  53. Kristoffer HaugsbakkJun 11, 2026
  54. Kristoffer HaugsbakkJun 17, 2026
  55. Junio C HamanoJul 23, 2026
  56. Kristoffer HaugsbakkJul 30, 2026
  57. Kristoffer HaugsbakkAug 13, 2026
  58. 00/11 doc: interpret-trailers: explain key formatkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  59. 01/11 doc: interpret-trailers: stop fixating on RFC 822kristofferhaugsbakk@fastmail.com, Jul 30, 2026
  60. 02/11 doc: interpret-trailers: replace “lines” with “metadata”kristofferhaugsbakk@fastmail.com, Jul 30, 2026
  61. 03/11 doc: interpret-trailers: use “metadata” in Name as wellkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  62. 04/11 doc: interpret-trailers: not just for commit messageskristofferhaugsbakk@fastmail.com, Jul 30, 2026
  63. 05/11 doc: interpret-trailers: explain the format after the introkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  64. 06/11 doc: interpret-trailers: explain key formatkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  65. 07/11 doc: interpret-trailers: add key format examplekristofferhaugsbakk@fastmail.com, Jul 30, 2026
  66. 08/11 doc: interpret-trailers: join new-trailers againkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  67. 09/11 doc: interpret-trailers: commit to “trailer block” termkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  68. 10/11 doc: interpret-trailers: rewrite new-trailers paragraphskristofferhaugsbakk@fastmail.com, Jul 30, 2026
  69. 11/11 doc: interpret-trailers: document comment line treatmentkristofferhaugsbakk@fastmail.com, Jul 30, 2026
  70. D. Ben KnobleAug 6, 2026
  71. Kristoffer HaugsbakkAug 8, 2026
  72. D. Ben KnobleAug 6, 2026
  73. Junio C HamanoAug 6, 2026
  74. Kristoffer HaugsbakkAug 8, 2026
  75. Kristoffer HaugsbakkAug 8, 2026
  76. 00/11 doc: interpret-trailers: explain key formatkristofferhaugsbakk@fastmail.com, Aug 9, 2026
  77. 01/11 doc: interpret-trailers: stop fixating on RFC 822kristofferhaugsbakk@fastmail.com, Aug 9, 2026
  78. 02/11 doc: interpret-trailers: replace “lines” with “metadata”kristofferhaugsbakk@fastmail.com, Aug 9, 2026
  79. 03/11 doc: interpret-trailers: use “metadata” in Name as wellkristofferhaugsbakk@fastmail.com, Aug 9, 2026
  80. 04/11 doc: interpret-trailers: not just for commit messageskristofferhaugsbakk@fastmail.com, Aug 9, 2026
  81. 05/11 doc: interpret-trailers: explain the format after the introkristofferhaugsbakk@fastmail.com, Aug 9, 2026
  82. 06/11 doc: interpret-trailers: explain key formatkristofferhaugsbakk@fastmail.com, Aug 9, 2026
  83. 07/11 doc: interpret-trailers: add key format examplekristofferhaugsbakk@fastmail.com, Aug 9, 2026
  84. 08/11 doc: interpret-trailers: join new-trailers againkristofferhaugsbakk@fastmail.com, Aug 9, 2026
  85. 09/11 doc: interpret-trailers: commit to “trailer block” termkristofferhaugsbakk@fastmail.com, Aug 9, 2026
  86. 10/11 doc: interpret-trailers: rewrite new-trailers paragraphskristofferhaugsbakk@fastmail.com, Aug 9, 2026
  87. 11/11 doc: interpret-trailers: document comment line treatmentkristofferhaugsbakk@fastmail.com, Aug 9, 2026
  88. Ben KnobleAug 10, 2026
  89. Kristoffer HaugsbakkAug 10, 2026
  90. Junio C HamanoAug 10, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.