]> git.baikalelectronics.ru Git - kernel.git/commit
docs: Explicitly state that the 'Fixes:' tag shouldn't split lines
authorSean Christopherson <sean.j.christopherson@intel.com>
Tue, 19 Feb 2019 15:27:15 +0000 (07:27 -0800)
committerJonathan Corbet <corbet@lwn.net>
Fri, 22 Feb 2019 15:56:23 +0000 (08:56 -0700)
commitee1256605ebe790a2bc0f1d2f1773d3dcb28dbf0
tree655f9246e5b08159ca4696ebebc6eb696b2a3edc
parent040502a6e4cfab418962f78721e1edbf3cae5f8d
docs: Explicitly state that the 'Fixes:' tag shouldn't split lines

...and use a commit with an obnoxiously long summary in the example to
make it abundantly clear that keeping the tag on a single line takes
priority over wrapping at 75 columns.  Without the explicit exemption,
one might assume splitting the tag is acceptable, even encouraged, e.g.
due to being conditioned by checkpatch's line length warning.

Per Stephen's scripts[1] and implied by commit 1b08c3185588 ("checkpatch:
avoid some commit message long line warnings"), splitting the 'Fixes:'
tag across multiple lines is a no-no, presumably because parsing multi-
line tags is unnecessarily painful.

[1] https://lkml.kernel.org/r/20190216183433.71b7cfa7@canb.auug.org.au

Cc: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/process/submitting-patches.rst