diff options
author | Jonathan Corbet <corbet@lwn.net> | 2014-12-23 10:52:01 -0500 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2014-12-23 10:52:01 -0500 |
commit | 0eea2314377146767273eadfc5b34b4f017777b2 (patch) | |
tree | c57fd8cf3f9d942cf00c942acea43df3c828ba00 /Documentation/SubmittingPatches | |
parent | ccae8616ecfb9506e7060f77c6cff2b782772fa0 (diff) |
Docs: SubmittingPatches: update follow-through instructions
SubmittingPatches was written in the "keep sending to Linus until something
shows up in a release" era. Given that we don't do things that way anymore
and the system is far less lossy, update this information and add some
hints on responding to reviewer comments.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/SubmittingPatches')
-rw-r--r-- | Documentation/SubmittingPatches | 50 |
1 files changed, 22 insertions, 28 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index e169c6ca5243..a8308401a048 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches | |||
@@ -354,40 +354,34 @@ server, and provide instead a URL (link) pointing to your patch. | |||
354 | 354 | ||
355 | 355 | ||
356 | 356 | ||
357 | 8) Name your kernel version. | 357 | 8) Respond to review comments. |
358 | 358 | ------------------------------ | |
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. | ||
361 | |||
362 | If the patch does not apply cleanly to the latest kernel version, | ||
363 | Linus will not apply it. | ||
364 | |||
365 | |||
366 | 359 | ||
367 | 9) Don't get discouraged. Re-submit. | 360 | Your patch will almost certainly get comments from reviewers on ways in |
361 | which the patch can be improved. You must respond to those comments; | ||
362 | ignoring reviewers is a good way to get ignored in return. Review comments | ||
363 | or questions that do not lead to a code change should almost certainly | ||
364 | bring about a comment or changelog entry so that the next reviewer better | ||
365 | understands what is going on. | ||
368 | 366 | ||
369 | After you have submitted your change, be patient and wait. If Linus | 367 | Be sure to tell the reviewers what changes you are making and to thank them |
370 | likes your change and applies it, it will appear in the next version | 368 | for their time. Code review is a tiring and time-consuming process, and |
371 | of the kernel that he releases. | 369 | reviewers sometimes get grumpy. Even in that case, though, respond |
370 | politely and address the problems they have pointed out. | ||
372 | 371 | ||
373 | However, if your change doesn't appear in the next version of the | ||
374 | kernel, there could be any number of reasons. It's YOUR job to | ||
375 | narrow down those reasons, correct what was wrong, and submit your | ||
376 | updated change. | ||
377 | 372 | ||
378 | It is quite common for Linus to "drop" your patch without comment. | 373 | 9) Don't get discouraged - or impatient. |
379 | That's the nature of the system. If he drops your patch, it could be | 374 | ---------------------------------------- |
380 | due to | ||
381 | * Your patch did not apply cleanly to the latest kernel version. | ||
382 | * Your patch was not sufficiently discussed on linux-kernel. | ||
383 | * A style issue (see section 2). | ||
384 | * An e-mail formatting issue (re-read this section). | ||
385 | * A technical problem with your change. | ||
386 | * He gets tons of e-mail, and yours got lost in the shuffle. | ||
387 | * You are being annoying. | ||
388 | 375 | ||
389 | When in doubt, solicit comments on linux-kernel mailing list. | 376 | After you have submitted your change, be patient and wait. Reviewers are |
377 | busy people and may not get to your patch right away. | ||
390 | 378 | ||
379 | Once upon a time, patches used to disappear into the void without comment, | ||
380 | but the development process works more smoothly than that now. You should | ||
381 | receive comments within a week or so; if that does not happen, make sure | ||
382 | that you have sent your patches to the right place. Wait for a minimum of | ||
383 | one week before resubmitting or pinging reviewers - possibly longer during | ||
384 | busy times like merge windows. | ||
391 | 385 | ||
392 | 386 | ||
393 | 10) Include PATCH in the subject | 387 | 10) Include PATCH in the subject |