diff options
| author | Paul Jackson <pj@sgi.com> | 2005-10-03 03:29:10 -0400 |
|---|---|---|
| committer | Linus Torvalds <torvalds@g5.osdl.org> | 2005-10-03 11:06:42 -0400 |
| commit | d6b9acc0c6c4a7c5d484d15271a5274656d0864f (patch) | |
| tree | 845765e077d9d436f1f2e7d57b9fe0e32a9e679a /Documentation | |
| parent | c77054e518d9163578cfcad09826d7b959f95ece (diff) | |
[PATCH] Document patch subject line better
Improve explanation of the Subject line fields in
Documentation/SubmittingPatches Canonical Patch Format.
Signed-off-by: Paul Jackson <pj@sgi.com>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/SubmittingPatches | 24 |
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 | ||
| 306 | The canonical patch subject line is: | 306 | The canonical patch subject line is: |
| 307 | 307 | ||
| 308 | Subject: [PATCH 001/123] [<area>:] <explanation> | 308 | Subject: [PATCH 001/123] subsystem: summary phrase |
| 309 | 309 | ||
| 310 | The canonical patch message body contains the following: | 310 | The canonical patch message body contains the following: |
| 311 | 311 | ||
| @@ -330,9 +330,25 @@ alphabetically by subject line - pretty much any email reader will | |||
| 330 | support that - since because the sequence number is zero-padded, | 330 | support that - since because the sequence number is zero-padded, |
| 331 | the numerical and alphabetic sort is the same. | 331 | the numerical and alphabetic sort is the same. |
| 332 | 332 | ||
| 333 | See further details on how to phrase the "<explanation>" in the | 333 | The "subsystem" in the email's Subject should identify which |
| 334 | "Subject:" line in Andrew Morton's "The perfect patch", referenced | 334 | area or subsystem of the kernel is being patched. |
| 335 | below. | 335 | |
| 336 | The "summary phrase" in the email's Subject should concisely | ||
| 337 | describe the patch which that email contains. The "summary | ||
| 338 | phrase" should not be a filename. Do not use the same "summary | ||
| 339 | phrase" for every patch in a whole patch series. | ||
| 340 | |||
| 341 | Bear in mind that the "summary phrase" of your email becomes | ||
| 342 | a globally-unique identifier for that patch. It propagates | ||
| 343 | all the way into the git changelog. The "summary phrase" may | ||
| 344 | later be used in developer discussions which refer to the patch. | ||
| 345 | People will want to google for the "summary phrase" to read | ||
| 346 | discussion regarding that patch. | ||
| 347 | |||
| 348 | A 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 | ||
| 337 | The "from" line must be the very first line in the message body, | 353 | The "from" line must be the very first line in the message body, |
| 338 | and has the form: | 354 | and has the form: |