aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/SubmittingPatches
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/SubmittingPatches')
-rw-r--r--Documentation/SubmittingPatches24
1 files changed, 20 insertions, 4 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 1d96efec5e8f..237d54c44bc5 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -305,7 +305,7 @@ point out some special detail about the sign-off.
305 305
306The canonical patch subject line is: 306The canonical patch subject line is:
307 307
308 Subject: [PATCH 001/123] [<area>:] <explanation> 308 Subject: [PATCH 001/123] subsystem: summary phrase
309 309
310The canonical patch message body contains the following: 310The canonical patch message body contains the following:
311 311
@@ -330,9 +330,25 @@ alphabetically by subject line - pretty much any email reader will
330support that - since because the sequence number is zero-padded, 330support that - since because the sequence number is zero-padded,
331the numerical and alphabetic sort is the same. 331the numerical and alphabetic sort is the same.
332 332
333See further details on how to phrase the "<explanation>" in the 333The "subsystem" in the email's Subject should identify which
334"Subject:" line in Andrew Morton's "The perfect patch", referenced 334area or subsystem of the kernel is being patched.
335below. 335
336The "summary phrase" in the email's Subject should concisely
337describe the patch which that email contains. The "summary
338phrase" should not be a filename. Do not use the same "summary
339phrase" for every patch in a whole patch series.
340
341Bear in mind that the "summary phrase" of your email becomes
342a globally-unique identifier for that patch. It propagates
343all the way into the git changelog. The "summary phrase" may
344later be used in developer discussions which refer to the patch.
345People will want to google for the "summary phrase" to read
346discussion regarding that patch.
347
348A couple of example Subjects:
349
350 Subject: [patch 2/5] ext2: improve scalability of bitmap searching
351 Subject: [PATCHv2 001/207] x86: fix eflags tracking
336 352
337The "from" line must be the very first line in the message body, 353The "from" line must be the very first line in the message body,
338and has the form: 354and has the form: