OSDN Git Service

Documentation/submitting-patches: Extend commit message layout description
authorBorislav Petkov <bp@suse.de>
Mon, 15 Feb 2021 14:19:49 +0000 (15:19 +0100)
committerJonathan Corbet <corbet@lwn.net>
Sun, 7 Mar 2021 00:36:52 +0000 (17:36 -0700)
commit875f82cb374b16e2edd700c4270f372247199b1e
tree41183cd1c237e405a8edb361db7b9e8790d53fc5
parent315c4e45f10d216b371d2e2eddef228bbafaec72
Documentation/submitting-patches: Extend commit message layout description

Add more blurb about the level of detail that should be contained in a
patch's commit message. Extend and make more explicit what text should
be added under the --- line. Extend examples and split into more easily
palatable paragraphs.

This has been partially carved out from a tip subsystem handbook
patchset by Thomas Gleixner:

  https://lkml.kernel.org/r/20181107171010.421878737@linutronix.de

and incorporates follow-on comments.

Signed-off-by: Borislav Petkov <bp@suse.de>
Reviewed-by: Robert Richter <rrichter@amd.com>
Link: https://lore.kernel.org/r/20210215141949.GB21734@zn.tnic
[jc: Tweaked "example subjects" wording]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/process/submitting-patches.rst