doc: interpret-trailers: add key format example
All of the examples speak of the Happy Path where everything works as intended. But failure examples can also be instructive. Especially for explaining again, by example, the key format (see previous commit). This also allows us to demonstrate trailer block detection with a concrete example. Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Kristoffer Haugsbakk committed
Jul 30, 2026 at 11:18 UTC
708e71d6f56e32185b3e8c0fde2934900f8048c0
1 file changed
+23
Documentation/git-interpret-trailers.adoc
+23
@@ -405,6 +405,29 @@ mv "\$1.new" "\$1"
405
$ chmod +x .git/hooks/commit-msg
406
------------
407
408
+* Here we try to use three different trailer keys. But it fails because
409
+ two of them are not recognized as trailer keys.
410
++
411
+----
412
+$ cat msg.txt
413
+subject
414
+
415
+Skapad-på: some-branch
416
+Hash-in-v6.11: 45c12d3269fe48f22834320c782ffe86c3560f2c
417
+Reviewed-by: Alice <alice@example.com>
418
+$ git interpret-trailers --only-trailers <msg.txt
419
+$
420
+----
421
++
422
+Recall that a trailer key has to consist of only ASCII alphanumeric
423
+characters and hyphens, and this does not hold for the two first
424
+supposed trailer keys. And now none are recognized as trailers because
425
+the candidate trailer block has at least one non-trailer line, even
426
+though `Reviewed-by` is a valid trailer key. Recall that a trailer block
427
+has to either (i) be all trailers, or (ii) consist of at least one
428
+Git-generated or user-configured trailer (and some other conditions).
429
+And (ii) is not satisfied since we have not configured any trailer keys.
430
+
431
SEE ALSO
432
--------
433
linkgit:git-commit[1], linkgit:git-format-patch[1], linkgit:git-config[1]