Skip to content

Commit 4e06417

Browse files
LemmingAvalanchegitster
authored andcommitted
doc: interpret-trailers: document comment line treatment
Comment lines have always been ignored but this is not documented. This is mostly for completeness since this is unlikely to catch anyone by surprise. But we really ought to be reasonably complete here since it’s the only documentation page that documents trailers. Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent dd19621 commit 4e06417

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Documentation/git-interpret-trailers.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,10 @@ of the message in turn is either (i) at the end of the input, or (ii)
103103
the last non-whitespace lines before a line that starts with `---`
104104
(followed by a space or the end of the line).
105105

106+
This command ignores comment lines (see `core.commentString` in
107+
linkgit:git-config[1]). This is for use with the `prepare-commit-msg`
108+
and `commit-msg` hooks.
109+
106110
When reading trailers, there can be no whitespace before or inside the
107111
_<key>_, but any number of regular space and tab characters are allowed
108112
between the _<key>_ and the separator. There can be whitespaces before,

0 commit comments

Comments
 (0)