diff options
author | Jonathan Corbet <corbet@lwn.net> | 2014-12-23 10:49:18 -0500 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2014-12-23 10:49:18 -0500 |
commit | ccae8616ecfb9506e7060f77c6cff2b782772fa0 (patch) | |
tree | c14948cf9dbbf9d4a7cdd0b65adf2d03235ad3cb /Documentation/SubmittingPatches | |
parent | 7994cc15d83c6188a77516f4c8400d3a4965b0a5 (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/SubmittingPatches | 107 |
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 | |||
250 | patch. | 250 | patch. |
251 | 251 | ||
252 | 252 | ||
253 | 5) Select e-mail destination. | 253 | 5) Select the recipients for your patch. |
254 | 254 | ---------------------------------------- | |
255 | Look through the MAINTAINERS file and the source code, and determine | 255 | |
256 | if your change applies to a specific subsystem of the kernel, with | 256 | You should always copy the appropriate subsystem maintainer(s) on any patch |
257 | an assigned maintainer. If so, e-mail that person. The script | 257 | to code that they maintain; look through the MAINTAINERS file and the |
258 | scripts/get_maintainer.pl can be very useful at this step. | 258 | source code revision history to see who those maintainers are. The |
259 | 259 | script scripts/get_maintainer.pl can be very useful at this step. If you | |
260 | If no maintainer is listed, or the maintainer does not respond, send | 260 | cannot find a maintainer for the subsystem your are working on, Andrew |
261 | your patch to the primary Linux kernel developer's mailing list, | 261 | Morton (akpm@linux-foundation.org) serves as a maintainer of last resort. |
262 | linux-kernel@vger.kernel.org. Most kernel developers monitor this | 262 | |
263 | e-mail list, and can comment on your changes. | 263 | You should also normally choose at least one mailing list to receive a copy |
264 | 264 | of your patch set. linux-kernel@vger.kernel.org functions as a list of | |
265 | last resort, but the volume on that list has caused a number of developers | ||
266 | to tune it out. Look in the MAINTAINERS file for a subsystem-specific | ||
267 | list; your patch will probably get more attention there. Please do not | ||
268 | spam unrelated lists, though. | ||
269 | |||
270 | Many kernel-related lists are hosted on vger.kernel.org; you can find a | ||
271 | list of them at http://vger.kernel.org/vger-lists.html. There are | ||
272 | kernel-related lists hosted elsewhere as well, though. | ||
265 | 273 | ||
266 | Do not send more than 15 patches at once to the vger mailing lists!!! | 274 | Do not send more than 15 patches at once to the vger mailing lists!!! |
267 | 275 | ||
268 | |||
269 | Linus Torvalds is the final arbiter of all changes accepted into the | 276 | Linus Torvalds is the final arbiter of all changes accepted into the |
270 | Linux kernel. His e-mail address is <torvalds@linux-foundation.org>. | 277 | Linux kernel. His e-mail address is <torvalds@linux-foundation.org>. |
271 | He gets a lot of e-mail, so typically you should do your best to -avoid- | 278 | He gets a lot of e-mail, and, at this point, very few patches go through |
272 | sending him e-mail. | 279 | Linus directly, so typically you should do your best to -avoid- |
273 | 280 | sending him e-mail. | |
274 | Patches which are bug fixes, are "obvious" changes, or similarly | ||
275 | require little discussion should be sent or CC'd to Linus. Patches | ||
276 | which require discussion or do not have a clear advantage should | ||
277 | usually be sent first to linux-kernel. Only after the patch is | ||
278 | discussed should the patch then be submitted to Linus. | ||
279 | |||
280 | |||
281 | 281 | ||
282 | 6) Select your CC (e-mail carbon copy) list. | 282 | If you have a patch that fixes an exploitable security bug, send that patch |
283 | to security@kernel.org. For severe bugs, a short embargo may be considered | ||
284 | to allow distrbutors to get the patch out to users; in such cases, | ||
285 | obviously, the patch should not be sent to any public lists. | ||
283 | 286 | ||
284 | Unless you have a reason NOT to do so, CC linux-kernel@vger.kernel.org. | 287 | Patches that fix a severe bug in a released kernel should be directed |
288 | toward the stable maintainers by putting a line like this: | ||
285 | 289 | ||
286 | Other kernel developers besides Linus need to be aware of your change, | 290 | Cc: stable@vger.kernel.org |
287 | so that they may comment on it and offer code review and suggestions. | ||
288 | linux-kernel is the primary Linux kernel developer mailing list. | ||
289 | Other mailing lists are available for specific subsystems, such as | ||
290 | USB, framebuffer devices, the VFS, the SCSI subsystem, etc. See the | ||
291 | MAINTAINERS file for a mailing list that relates specifically to | ||
292 | your change. | ||
293 | 291 | ||
294 | Majordomo lists of VGER.KERNEL.ORG at: | 292 | into your patch. |
295 | <http://vger.kernel.org/vger-lists.html> | ||
296 | 293 | ||
297 | If changes affect userland-kernel interfaces, please send | 294 | Note, however, that some subsystem maintainers want to come to their own |
298 | the MAN-PAGES maintainer (as listed in the MAINTAINERS file) | 295 | conclusions on which patches should go to the stable trees. The networking |
299 | a man-pages patch, or at least a notification of the change, | 296 | maintainer, in particular, would rather not see individual developers |
300 | so that some information makes its way into the manual pages. | 297 | adding lines like the above to their patches. |
301 | 298 | ||
302 | Even if the maintainer did not respond in step #5, make sure to ALWAYS | 299 | If changes affect userland-kernel interfaces, please send the MAN-PAGES |
303 | copy the maintainer when you change their code. | 300 | maintainer (as listed in the MAINTAINERS file) a man-pages patch, or at |
301 | least a notification of the change, so that some information makes its way | ||
302 | into the manual pages. User-space API changes should also be copied to | ||
303 | linux-api@vger.kernel.org. | ||
304 | 304 | ||
305 | For small patches you may want to CC the Trivial Patch Monkey | 305 | For small patches you may want to CC the Trivial Patch Monkey |
306 | trivial@kernel.org which collects "trivial" patches. Have a look | 306 | trivial@kernel.org which collects "trivial" patches. Have a look |
307 | into the MAINTAINERS file for its current manager. | 307 | into the MAINTAINERS file for its current manager. |
308 | Trivial patches must qualify for one of the following rules: | 308 | Trivial 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 | ||
323 | 7) No MIME, no links, no compression, no attachments. Just plain text. | 323 | 6) No MIME, no links, no compression, no attachments. Just plain text. |
324 | 324 | ||
325 | Linus and other kernel developers need to be able to read and comment | 325 | Linus and other kernel developers need to be able to read and comment |
326 | on the changes you are submitting. It is important for a kernel | 326 | on the changes you are submitting. It is important for a kernel |
@@ -343,7 +343,7 @@ you to re-send them using MIME. | |||
343 | See Documentation/email-clients.txt for hints about configuring | 343 | See Documentation/email-clients.txt for hints about configuring |
344 | your e-mail client so that it sends your patches untouched. | 344 | your e-mail client so that it sends your patches untouched. |
345 | 345 | ||
346 | 8) E-mail size. | 346 | 7) E-mail size. |
347 | 347 | ||
348 | When sending patches to Linus, always follow step #7. | 348 | When 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 | ||
357 | 9) Name your kernel version. | 357 | 8) Name your kernel version. |
358 | 358 | ||
359 | It is important to note, either in the subject line or in the patch | 359 | It is important to note, either in the subject line or in the patch |
360 | description, the kernel version to which this patch applies. | 360 | description, the kernel version to which this patch applies. |
@@ -364,7 +364,7 @@ Linus will not apply it. | |||
364 | 364 | ||
365 | 365 | ||
366 | 366 | ||
367 | 10) Don't get discouraged. Re-submit. | 367 | 9) Don't get discouraged. Re-submit. |
368 | 368 | ||
369 | After you have submitted your change, be patient and wait. If Linus | 369 | After you have submitted your change, be patient and wait. If Linus |
370 | likes your change and applies it, it will appear in the next version | 370 | likes 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 | ||
393 | 11) Include PATCH in the subject | 393 | 10) Include PATCH in the subject |
394 | 394 | ||
395 | Due to high e-mail traffic to Linus, and to linux-kernel, it is common | 395 | Due to high e-mail traffic to Linus, and to linux-kernel, it is common |
396 | convention to prefix your subject line with [PATCH]. This lets Linus | 396 | convention to prefix your subject line with [PATCH]. This lets Linus |
@@ -399,7 +399,7 @@ e-mail discussions. | |||
399 | 399 | ||
400 | 400 | ||
401 | 401 | ||
402 | 12) Sign your work | 402 | 11) Sign your work |
403 | 403 | ||
404 | To improve tracking of who did what, especially with patches that can | 404 | To improve tracking of who did what, especially with patches that can |
405 | percolate to their final resting place in the kernel through several | 405 | percolate 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 | |||
494 | tree. | 494 | tree. |
495 | 495 | ||
496 | 496 | ||
497 | 13) When to use Acked-by: and Cc: | 497 | 12) When to use Acked-by: and Cc: |
498 | 498 | ||
499 | The Signed-off-by: tag indicates that the signer was involved in the | 499 | The Signed-off-by: tag indicates that the signer was involved in the |
500 | development of the patch, or that he/she was in the patch's delivery path. | 500 | development 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 | |||
525 | have been included in the discussion | 525 | have been included in the discussion |
526 | 526 | ||
527 | 527 | ||
528 | 14) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: | 528 | 13) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: |
529 | 529 | ||
530 | The Reported-by tag gives credit to people who find bugs and report them and it | 530 | The Reported-by tag gives credit to people who find bugs and report them and it |
531 | hopefully inspires them to help us again in the future. Please note that if | 531 | hopefully 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 | |||
585 | method for indicating a bug fixed by the patch. See #2 above for more details. | 585 | method for indicating a bug fixed by the patch. See #2 above for more details. |
586 | 586 | ||
587 | 587 | ||
588 | 15) The canonical patch format | 588 | 14) The canonical patch format |
589 | ------------------------------ | 589 | ------------------------------ |
590 | 590 | ||
591 | This section describes how the patch itself should be formatted. Note | 591 | This section describes how the patch itself should be formatted. Note |
@@ -599,7 +599,8 @@ The canonical patch subject line is: | |||
599 | 599 | ||
600 | The canonical patch message body contains the following: | 600 | The 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 | |||
706 | references. | 707 | references. |
707 | 708 | ||
708 | 709 | ||
709 | 16) Sending "git pull" requests | 710 | 15) Sending "git pull" requests |
710 | ------------------------------- | 711 | ------------------------------- |
711 | 712 | ||
712 | If you have a series of patches, it may be most convenient to have the | 713 | If you have a series of patches, it may be most convenient to have the |