summaryrefslogtreecommitdiffstats
path: root/Documentation/SubmittingPatches
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2014-12-23 10:49:18 -0500
committerJonathan Corbet <corbet@lwn.net>2014-12-23 10:49:18 -0500
commitccae8616ecfb9506e7060f77c6cff2b782772fa0 (patch)
treec14948cf9dbbf9d4a7cdd0b65adf2d03235ad3cb /Documentation/SubmittingPatches
parent7994cc15d83c6188a77516f4c8400d3a4965b0a5 (diff)
Docs: Update recipient information in SubmittingPatches
SubmittingPatches had two sections on selecting recipients; both were showing their age. Unify them into a single section that more closely reflects how we do things now. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/SubmittingPatches')
-rw-r--r--Documentation/SubmittingPatches107
1 files changed, 54 insertions, 53 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 230a3b892db6..e169c6ca5243 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -250,68 +250,68 @@ You should be able to justify all violations that remain in your
250patch. 250patch.
251 251
252 252
2535) Select e-mail destination. 2535) Select the recipients for your patch.
254 254----------------------------------------
255Look through the MAINTAINERS file and the source code, and determine 255
256if your change applies to a specific subsystem of the kernel, with 256You should always copy the appropriate subsystem maintainer(s) on any patch
257an assigned maintainer. If so, e-mail that person. The script 257to code that they maintain; look through the MAINTAINERS file and the
258scripts/get_maintainer.pl can be very useful at this step. 258source code revision history to see who those maintainers are. The
259 259script scripts/get_maintainer.pl can be very useful at this step. If you
260If no maintainer is listed, or the maintainer does not respond, send 260cannot find a maintainer for the subsystem your are working on, Andrew
261your patch to the primary Linux kernel developer's mailing list, 261Morton (akpm@linux-foundation.org) serves as a maintainer of last resort.
262linux-kernel@vger.kernel.org. Most kernel developers monitor this 262
263e-mail list, and can comment on your changes. 263You should also normally choose at least one mailing list to receive a copy
264 264of your patch set. linux-kernel@vger.kernel.org functions as a list of
265last resort, but the volume on that list has caused a number of developers
266to tune it out. Look in the MAINTAINERS file for a subsystem-specific
267list; your patch will probably get more attention there. Please do not
268spam unrelated lists, though.
269
270Many kernel-related lists are hosted on vger.kernel.org; you can find a
271list of them at http://vger.kernel.org/vger-lists.html. There are
272kernel-related lists hosted elsewhere as well, though.
265 273
266Do not send more than 15 patches at once to the vger mailing lists!!! 274Do not send more than 15 patches at once to the vger mailing lists!!!
267 275
268
269Linus Torvalds is the final arbiter of all changes accepted into the 276Linus Torvalds is the final arbiter of all changes accepted into the
270Linux kernel. His e-mail address is <torvalds@linux-foundation.org>. 277Linux kernel. His e-mail address is <torvalds@linux-foundation.org>.
271He gets a lot of e-mail, so typically you should do your best to -avoid- 278He gets a lot of e-mail, and, at this point, very few patches go through
272sending him e-mail. 279Linus directly, so typically you should do your best to -avoid-
273 280sending him e-mail.
274Patches which are bug fixes, are "obvious" changes, or similarly
275require little discussion should be sent or CC'd to Linus. Patches
276which require discussion or do not have a clear advantage should
277usually be sent first to linux-kernel. Only after the patch is
278discussed should the patch then be submitted to Linus.
279
280
281 281
2826) Select your CC (e-mail carbon copy) list. 282If you have a patch that fixes an exploitable security bug, send that patch
283to security@kernel.org. For severe bugs, a short embargo may be considered
284to allow distrbutors to get the patch out to users; in such cases,
285obviously, the patch should not be sent to any public lists.
283 286
284Unless you have a reason NOT to do so, CC linux-kernel@vger.kernel.org. 287Patches that fix a severe bug in a released kernel should be directed
288toward the stable maintainers by putting a line like this:
285 289
286Other kernel developers besides Linus need to be aware of your change, 290 Cc: stable@vger.kernel.org
287so that they may comment on it and offer code review and suggestions.
288linux-kernel is the primary Linux kernel developer mailing list.
289Other mailing lists are available for specific subsystems, such as
290USB, framebuffer devices, the VFS, the SCSI subsystem, etc. See the
291MAINTAINERS file for a mailing list that relates specifically to
292your change.
293 291
294Majordomo lists of VGER.KERNEL.ORG at: 292into your patch.
295 <http://vger.kernel.org/vger-lists.html>
296 293
297If changes affect userland-kernel interfaces, please send 294Note, however, that some subsystem maintainers want to come to their own
298the MAN-PAGES maintainer (as listed in the MAINTAINERS file) 295conclusions on which patches should go to the stable trees. The networking
299a man-pages patch, or at least a notification of the change, 296maintainer, in particular, would rather not see individual developers
300so that some information makes its way into the manual pages. 297adding lines like the above to their patches.
301 298
302Even if the maintainer did not respond in step #5, make sure to ALWAYS 299If changes affect userland-kernel interfaces, please send the MAN-PAGES
303copy the maintainer when you change their code. 300maintainer (as listed in the MAINTAINERS file) a man-pages patch, or at
301least a notification of the change, so that some information makes its way
302into the manual pages. User-space API changes should also be copied to
303linux-api@vger.kernel.org.
304 304
305For small patches you may want to CC the Trivial Patch Monkey 305For small patches you may want to CC the Trivial Patch Monkey
306trivial@kernel.org which collects "trivial" patches. Have a look 306trivial@kernel.org which collects "trivial" patches. Have a look
307into the MAINTAINERS file for its current manager. 307into the MAINTAINERS file for its current manager.
308Trivial patches must qualify for one of the following rules: 308Trivial patches must qualify for one of the following rules:
309 Spelling fixes in documentation 309 Spelling fixes in documentation
310 Spelling fixes which could break grep(1) 310 Spelling fixes for errors which could break grep(1)
311 Warning fixes (cluttering with useless warnings is bad) 311 Warning fixes (cluttering with useless warnings is bad)
312 Compilation fixes (only if they are actually correct) 312 Compilation fixes (only if they are actually correct)
313 Runtime fixes (only if they actually fix things) 313 Runtime fixes (only if they actually fix things)
314 Removing use of deprecated functions/macros (eg. check_region) 314 Removing use of deprecated functions/macros
315 Contact detail and documentation fixes 315 Contact detail and documentation fixes
316 Non-portable code replaced by portable code (even in arch-specific, 316 Non-portable code replaced by portable code (even in arch-specific,
317 since people copy, as long as it's trivial) 317 since people copy, as long as it's trivial)
@@ -320,7 +320,7 @@ Trivial patches must qualify for one of the following rules:
320 320
321 321
322 322
3237) No MIME, no links, no compression, no attachments. Just plain text. 3236) No MIME, no links, no compression, no attachments. Just plain text.
324 324
325Linus and other kernel developers need to be able to read and comment 325Linus and other kernel developers need to be able to read and comment
326on the changes you are submitting. It is important for a kernel 326on the changes you are submitting. It is important for a kernel
@@ -343,7 +343,7 @@ you to re-send them using MIME.
343See Documentation/email-clients.txt for hints about configuring 343See Documentation/email-clients.txt for hints about configuring
344your e-mail client so that it sends your patches untouched. 344your e-mail client so that it sends your patches untouched.
345 345
3468) E-mail size. 3467) E-mail size.
347 347
348When sending patches to Linus, always follow step #7. 348When sending patches to Linus, always follow step #7.
349 349
@@ -354,7 +354,7 @@ server, and provide instead a URL (link) pointing to your patch.
354 354
355 355
356 356
3579) Name your kernel version. 3578) Name your kernel version.
358 358
359It is important to note, either in the subject line or in the patch 359It is important to note, either in the subject line or in the patch
360description, the kernel version to which this patch applies. 360description, the kernel version to which this patch applies.
@@ -364,7 +364,7 @@ Linus will not apply it.
364 364
365 365
366 366
36710) Don't get discouraged. Re-submit. 3679) Don't get discouraged. Re-submit.
368 368
369After you have submitted your change, be patient and wait. If Linus 369After you have submitted your change, be patient and wait. If Linus
370likes your change and applies it, it will appear in the next version 370likes your change and applies it, it will appear in the next version
@@ -390,7 +390,7 @@ When in doubt, solicit comments on linux-kernel mailing list.
390 390
391 391
392 392
39311) Include PATCH in the subject 39310) Include PATCH in the subject
394 394
395Due to high e-mail traffic to Linus, and to linux-kernel, it is common 395Due to high e-mail traffic to Linus, and to linux-kernel, it is common
396convention to prefix your subject line with [PATCH]. This lets Linus 396convention to prefix your subject line with [PATCH]. This lets Linus
@@ -399,7 +399,7 @@ e-mail discussions.
399 399
400 400
401 401
40212) Sign your work 40211) Sign your work
403 403
404To improve tracking of who did what, especially with patches that can 404To improve tracking of who did what, especially with patches that can
405percolate to their final resting place in the kernel through several 405percolate to their final resting place in the kernel through several
@@ -494,7 +494,7 @@ tracking your trees, and to people trying to troubleshoot bugs in your
494tree. 494tree.
495 495
496 496
49713) When to use Acked-by: and Cc: 49712) When to use Acked-by: and Cc:
498 498
499The Signed-off-by: tag indicates that the signer was involved in the 499The Signed-off-by: tag indicates that the signer was involved in the
500development of the patch, or that he/she was in the patch's delivery path. 500development of the patch, or that he/she was in the patch's delivery path.
@@ -525,7 +525,7 @@ person it names. This tag documents that potentially interested parties
525have been included in the discussion 525have been included in the discussion
526 526
527 527
52814) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: 52813) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:
529 529
530The Reported-by tag gives credit to people who find bugs and report them and it 530The Reported-by tag gives credit to people who find bugs and report them and it
531hopefully inspires them to help us again in the future. Please note that if 531hopefully inspires them to help us again in the future. Please note that if
@@ -585,7 +585,7 @@ which stable kernel versions should receive your fix. This is the preferred
585method for indicating a bug fixed by the patch. See #2 above for more details. 585method for indicating a bug fixed by the patch. See #2 above for more details.
586 586
587 587
58815) The canonical patch format 58814) The canonical patch format
589------------------------------ 589------------------------------
590 590
591This section describes how the patch itself should be formatted. Note 591This section describes how the patch itself should be formatted. Note
@@ -599,7 +599,8 @@ The canonical patch subject line is:
599 599
600The canonical patch message body contains the following: 600The canonical patch message body contains the following:
601 601
602 - A "from" line specifying the patch author. 602 - A "from" line specifying the patch author (only needed if the person
603 sending the patch is not the author).
603 604
604 - An empty line. 605 - An empty line.
605 606
@@ -706,7 +707,7 @@ See more details on the proper patch format in the following
706references. 707references.
707 708
708 709
70916) Sending "git pull" requests 71015) Sending "git pull" requests
710------------------------------- 711-------------------------------
711 712
712If you have a series of patches, it may be most convenient to have the 713If you have a series of patches, it may be most convenient to have the