]> git.ipfire.org Git - thirdparty/git.git/commit
doc: interpret-trailers: explain the format after the intro
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Thu, 30 Jul 2026 09:18:18 +0000 (11:18 +0200)
committerJunio C Hamano <gitster@pobox.com>
Thu, 30 Jul 2026 16:10:13 +0000 (09:10 -0700)
commitade06dca04833b87f64d163b8c41cd382352f43e
tree822102f5db8bf4e131fa05834fbd44f9ef9c85b6
parent73dd4314a948ebf92db98a81b7b9439c89c29d0a
doc: interpret-trailers: explain the format after the intro

You need to read the entire “Description” section in order to understand
the full trailer format. But there are many nuances, so that’s fine.
As a starter though we have an introductory example.[1] That turns out
to be crucial; the rest of this section talks about the mechanics of the
command and only incidentally the format itself.

Now, although the example might arguably be self-explanatory, we can
add a little preamble which defines the format in its simplest form as
well as define the most important terms.

Note that we name the “blank line” rule since I want to use that term
every time it comes up. It gets very mildly obfuscated if you call it
a “blank line” in one place[2] and “empty (or whitespace-only) ...” in
another one.[3]

We will define the format of the *key* in the next commit.

† 1: from d57fa7fc (doc: trailer: add more examples in DESCRIPTION,
     2023-06-15)
† 2: `Documentation/git-interpret-trailers.adoc:86` in
     5361983c (The 22nd batch, 2026-03-27)
† 3: `Documentation/git-interpret-trailers.adoc:93` in
     5361983c (The 22nd batch, 2026-03-27)

Suggested-by: D. Ben Knoble <ben.knoble+github@gmail.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-interpret-trailers.adoc