@matheusbsbs / matheus-bagliano / commits / b46dd1726c

Documentation: clarify whitespace rules for trailers

Commit e4319562bc (trailer: be stricter in parsing separators, 2016-11-02) restricted whitespaces allowed by `git interpret-trailers` in the "token" part of the trailers it reads. This commit didn't update the related documentation in Documentation/git-interpret-trailers.txt though. Also commit 60ef86a162 (trailer: support values folded to multiple lines, 2016-10-21) updated the documentation, but didn't make it clear how many whitespace characters are allowed at the beginning of new lines in folded values. Let's fix both of these issues by rewriting the paragraph describing what whitespaces are allowed by `git interpret-trailers` in the trailers it reads. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Christian Couder committed Aug 30, 2022 at 12:50 UTC b46dd1726c139c930d7b4b7c3262e3f2699987d3

1 file changed +6 -4

Documentation/git-interpret-trailers.txt

+6 -4

@@ -60,10 +60,12 @@ non-whitespace lines before a line that starts with '---' (followed by a

60 space or the end of the line). Such three minus signs start the patch

61 part of the message. See also `--no-divider` below.

63 -When reading trailers, there can be whitespaces after the

64 -token, the separator and the value. There can also be whitespaces

65 -inside the token and the value. The value may be split over multiple lines with

66 -each subsequent line starting with whitespace, like the "folding" in RFC 822.

63 +When reading trailers, there can be no whitespace before or inside the

64 +token, but any number of regular space and tab characters are allowed

65 +between the token and the separator. There can be whitespaces before,

66 +inside or after the value. The value may be split over multiple lines

67 +with each subsequent line starting with at least one whitespace, like

68 +the "folding" in RFC 822.

70 Note that 'trailers' do not follow and are not intended to follow many

71 rules for RFC 822 headers. For example they do not follow