Skip to contentSkip to conversation

SubmittingPatches: make Subject examples match the de facto standard

PATCH Applied Alex Henrie 2 participants 3 messages Sep 20, 2015 – Sep 24, 2015 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 SubmittingPatches: make Subject examples match the de facto standard

The examples should better match what kernel developers actually expect, so that they set a good example both for this project and for other projects with similar development processes.

---
 Documentation/SubmittingPatches | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/SubmittingPatches +4 -4
index fd89b04..4710e4a 100644
@@ -659,8 +659,8 @@ succinct and descriptive, but that is what a well-written summary
 should do.
 
 The "summary phrase" may be prefixed by tags enclosed in square
-brackets: "Subject: [PATCH tag] <summary phrase>".  The tags are not
-considered part of the summary phrase, but describe how the patch
+brackets: "Subject: [PATCH <tag>...] <summary phrase>".  The tags are
+not considered part of the summary phrase, but describe how the patch
 should be treated.  Common tags might include a version descriptor if
 the multiple versions of the patch have been sent out in response to
 comments (i.e., "v1, v2, v3"), or "RFC" to indicate a request for
@@ -672,8 +672,8 @@ the patch series.
 
 A couple of example Subjects:
 
-    Subject: [patch 2/5] ext2: improve scalability of bitmap searching
-    Subject: [PATCHv2 001/207] x86: fix eflags tracking
+    Subject: [PATCH 2/5] ext2: improve scalability of bitmap searching
+    Subject: [PATCH v2 01/27] x86: fix eflags tracking
 
 The "from" line must be the very first line in the message body,
 and has the form:
Signature · 1 line
2.5.2
maintainer Applied
#1 lore raw
Quoted 3 lines · On Sun, 20 Sep 2015 14:11:19 +0200 Alex Henrie <[email protected]> wrote:

The examples should better match what kernel developers actually expect, so that they set a good example both for this project and for other projects with similar development processes.

Applied to the docs tree, thanks.

jon

#2 lore raw

2015-09-24 23:57 GMT+02:00 Jonathan Corbet <[email protected]>:

Quoted 8 lines
Quoted 3 lines · On Sun, 20 Sep 2015 14:11:19 +0200 Alex Henrie <[email protected]> wrote:

The examples should better match what kernel developers actually expect, so that they set a good example both for this project and for other projects with similar development processes.

Applied to the docs tree, thanks.

Thank you! The little things do matter ;-)

-Alex