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

[PATCH v5 08/11] doc: interpret-trailers: join new-trailers again

From
Kkristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
Date
Aug 9, 2026, 20:06 UTC
Message-ID
<V5_join_paragraphs.b2e@msgid.xyz>
In-Reply-To
<V5_CV_doc_int-tr_key_format.b26@msgid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>

There are three paragraphs that talk about how a new trailer is added. But the first one is separated from the other two by two paragraphs about how `key-alias` can make using `--trailer` more convenient. This short how-to does not follow thematically from the previous paragraph, and can wait until we have fully described how a new trailer is added. So let’s move the three paragraphs about the new-trailer topic together and move the how-to paragraphs after that.

***

Let’s now review the history of the document. Even if the document is not quite correct in its current state, just doing the apparently obvious edit without considering the history does not respect the effort that went into changing the document in the past.

These three paragraphs were originally next to each other, in the first version of the doc.[1] But extra sentences about this how-to topic was added to the first paragraph nine years later:[2]

    [...]
    `': '` (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 [...]
And then it was split into it’s own paragraph a little later.[3]

This evolution shows, in my opinion, that this how-to never followed thematically from the existing topic. Which means that there is nothing that was potentially lost to time that we need to restore or respect.

† 1: dfd66ddf (Documentation: add documentation for 'git
     interpret-trailers', 2014-10-13)
† 2: eda2c44c (doc: trailer: mention 'key' in DESCRIPTION, 2023-06-15)
† 3: 6ccbc667 (trailer doc: <token> is a <key> or <keyAlias>, not both,
     2023-09-07)
Suggested-by: D. Ben Knoble <ben.knoble+github@gmail.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
    v4:
    • Msg: Fix word-confusion: s/There are three trailers/There are
      three paragraphs.
    
      🔗 https://lore.kernel.org/git/CALnO6CCg4ubVz_VJuFjn7tvXqADR40AdjCFJ6xfRcms9a+GQWA@mail.gmail.com/
    
      I knew that I was going to fix this when I started on
      version 4. But you would not believe how many times I
      went over the commit log without seeing that I had
      neglected to do this part.
    
    ---
    
    v3: [new]
    • Suggested here: https://lore.kernel.org/git/CALnO6CBiRefHNT6tjskCQRUOj5Y--K3okR_RFPmth6O7s1_VKQ@mail.gmail.com/
    • Msg: Now *this* might definitely make for an *overly verbose* cmt msg[1]
    
      🔗 1: https://lore.kernel.org/git/xmqqpl1zsv8s.fsf@gitster.g/
 Documentation/git-interpret-trailers.adoc | 26 +++++++++++------------
 1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/Documentation/git-interpret-trailers.adoc b/Documentation/git-interpret-trailers.adoc
index a0f7ed6fdd9..616f479a367 100644
--- a/Documentation/git-interpret-trailers.adoc
+++ b/Documentation/git-interpret-trailers.adoc
@@ -74,19 +74,6 @@ key: value
 This means that the trimmed _<key>_ and _<value>_ will be separated by
 "`:`{nbsp}" (one colon followed by one space).
 
-For convenience, a _<key-alias>_ can be configured to make using `--trailer`
-shorter to type on the command line. This can be configured using the
-`trailer.<key-alias>.key` configuration variable. The _<key-alias>_ must be a prefix
-of the full _<key>_ string, although case sensitivity does not matter. For
-example, if you have
-
-------------------------------------------------
-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
@@ -101,6 +88,19 @@ The group must either be at the end of the input or be the last
 non-whitespace lines before a line that starts with `---` (followed by a
 space or the end of the line).
 
+For convenience, a _<key-alias>_ can be configured to make using `--trailer`
+shorter to type on the command line. This can be configured using the
+`trailer.<key-alias>.key` configuration variable. The _<key-alias>_ must be a prefix
+of the full _<key>_ string, although case sensitivity does not matter. For
+example, if you have
+
+------------------------------------------------
+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"`.
+
 When reading trailers, there can be no whitespace before or inside the
 _<key>_, but any number of regular space and tab characters are allowed
 between the _<key>_ and the separator. There can be whitespaces before,
-- 
2.54.0.22.g9e26862b904
Previous: kristofferhaugsbakk@fastmail.comNext: kristofferhaugsbakk@fastmail.com
Message 84 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.