Messages in this thread | | | From | Jonathan Corbet <> | Subject | Re: [PATCH] Documentation/submitting-patches: Extend commit message layout description | Date | Mon, 01 Mar 2021 15:10:11 -0700 |
| |
Borislav Petkov <bp@alien8.de> writes:
> From: Borislav Petkov <bp@suse.de> > Subject: [PATCH] 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> > --- > > /me sends the next generic topic blurb. > > Documentation/process/submitting-patches.rst | 89 ++++++++++++-------- > 1 file changed, 56 insertions(+), 33 deletions(-)
Applied, with one tweak:
> +If there are four patches in a patch series the individual patches may > +be numbered like this: 1/4, 2/4, 3/4, 4/4. This assures that developers > +understand the order in which the patches should be applied and that > +they have reviewed or applied all of the patches in the patch series. > > A couple of example Subjects:: > > Subject: [PATCH 2/5] ext2: improve scalability of bitmap searching > Subject: [PATCH v2 01/27] x86: fix eflags tracking > + Subject: [PATCH v2] sub/sys: Condensed patch summary > + Subject: [PATCH v2 M/N] sub/sys: Condensed patch summary
It's no longer "a couple" so I made this "Here are some good example Subjects".
Thanks,
jon
| |