]>
Commit | Line | Data |
---|---|---|
609d99a3 | 1 | .. _submittingpatches: |
1da177e4 | 2 | |
89edeedd JC |
3 | Submitting patches: the essential guide to getting your code into the kernel |
4 | ============================================================================ | |
1da177e4 LT |
5 | |
6 | For a person or company who wishes to submit a change to the Linux | |
7 | kernel, the process can sometimes be daunting if you're not familiar | |
8 | with "the system." This text is a collection of suggestions which | |
9 | can greatly increase the chances of your change being accepted. | |
10 | ||
d00c4559 JC |
11 | This document contains a large number of suggestions in a relatively terse |
12 | format. For detailed information on how the kernel development process | |
0e4f07a6 | 13 | works, see :ref:`Documentation/process <development_process_main>`. |
8c27ceff | 14 | Also, read :ref:`Documentation/process/submit-checklist.rst <submitchecklist>` |
dca22a63 | 15 | for a list of items to check before |
d00c4559 | 16 | submitting code. If you are submitting a driver, also read |
8c27ceff | 17 | :ref:`Documentation/process/submitting-drivers.rst <submittingdrivers>`; |
dca22a63 | 18 | for device tree binding patches, read |
082bd1ca | 19 | Documentation/devicetree/bindings/submitting-patches.txt. |
1da177e4 | 20 | |
9b2c7677 MCC |
21 | Many of these steps describe the default behavior of the ``git`` version |
22 | control system; if you use ``git`` to prepare your patches, you'll find much | |
8e3072a2 | 23 | of the mechanical work done for you, though you'll still need to prepare |
9b2c7677 | 24 | and document a sensible set of patches. In general, use of ``git`` will make |
d00c4559 | 25 | your life as a kernel developer easier. |
1da177e4 | 26 | |
7994cc15 JC |
27 | 0) Obtain a current source tree |
28 | ------------------------------- | |
29 | ||
30 | If you do not have a repository with the current kernel source handy, use | |
9b2c7677 | 31 | ``git`` to obtain one. You'll want to start with the mainline repository, |
5903019b | 32 | which can be grabbed with:: |
7994cc15 | 33 | |
5903019b | 34 | git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git |
7994cc15 JC |
35 | |
36 | Note, however, that you may not want to develop against the mainline tree | |
37 | directly. Most subsystem maintainers run their own trees and want to see | |
5903019b | 38 | patches prepared against those trees. See the **T:** entry for the subsystem |
7994cc15 JC |
39 | in the MAINTAINERS file to find that tree, or simply ask the maintainer if |
40 | the tree is not listed there. | |
41 | ||
42 | It is still possible to download kernel releases via tarballs (as described | |
43 | in the next section), but that is the hard way to do kernel development. | |
1da177e4 | 44 | |
5903019b MCC |
45 | 1) ``diff -up`` |
46 | --------------- | |
1da177e4 | 47 | |
5903019b | 48 | If you must generate your patches by hand, use ``diff -up`` or ``diff -uprN`` |
7994cc15 | 49 | to create patches. Git generates patches in this form by default; if |
9b2c7677 | 50 | you're using ``git``, you can skip this section entirely. |
1da177e4 LT |
51 | |
52 | All changes to the Linux kernel occur in the form of patches, as | |
9b2c7677 MCC |
53 | generated by :manpage:`diff(1)`. When creating your patch, make sure to |
54 | create it in "unified diff" format, as supplied by the ``-u`` argument | |
55 | to :manpage:`diff(1)`. | |
5903019b | 56 | Also, please use the ``-p`` argument which shows which C function each |
9b2c7677 | 57 | change is in - that makes the resultant ``diff`` a lot easier to read. |
1da177e4 LT |
58 | Patches should be based in the root kernel source directory, |
59 | not in any lower subdirectory. | |
60 | ||
5903019b | 61 | To create a patch for a single file, it is often sufficient to do:: |
1da177e4 | 62 | |
d00c4559 | 63 | SRCTREE= linux |
1da177e4 LT |
64 | MYFILE= drivers/net/mydriver.c |
65 | ||
66 | cd $SRCTREE | |
67 | cp $MYFILE $MYFILE.orig | |
68 | vi $MYFILE # make your change | |
69 | cd .. | |
70 | diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch | |
71 | ||
72 | To create a patch for multiple files, you should unpack a "vanilla", | |
9b2c7677 | 73 | or unmodified kernel source tree, and generate a ``diff`` against your |
5903019b | 74 | own source tree. For example:: |
1da177e4 | 75 | |
d00c4559 | 76 | MYSRC= /devel/linux |
1da177e4 | 77 | |
d00c4559 JC |
78 | tar xvfz linux-3.19.tar.gz |
79 | mv linux-3.19 linux-3.19-vanilla | |
80 | diff -uprN -X linux-3.19-vanilla/Documentation/dontdiff \ | |
81 | linux-3.19-vanilla $MYSRC > /tmp/patch | |
1da177e4 | 82 | |
5903019b | 83 | ``dontdiff`` is a list of files which are generated by the kernel during |
9b2c7677 | 84 | the build process, and should be ignored in any :manpage:`diff(1)`-generated |
d00c4559 | 85 | patch. |
1da177e4 LT |
86 | |
87 | Make sure your patch does not include any extra files which do not | |
88 | belong in a patch submission. Make sure to review your patch -after- | |
9b2c7677 | 89 | generating it with :manpage:`diff(1)`, to ensure accuracy. |
1da177e4 | 90 | |
8e3072a2 | 91 | If your changes produce a lot of deltas, you need to split them into |
5903019b MCC |
92 | individual patches which modify things in logical stages; see |
93 | :ref:`split_changes`. This will facilitate review by other kernel developers, | |
8e3072a2 | 94 | very important if you want your patch accepted. |
1da177e4 | 95 | |
9b2c7677 MCC |
96 | If you're using ``git``, ``git rebase -i`` can help you with this process. If |
97 | you're not using ``git``, ``quilt`` <http://savannah.nongnu.org/projects/quilt> | |
8e3072a2 | 98 | is another popular alternative. |
84da7c08 | 99 | |
5903019b | 100 | .. _describe_changes: |
84da7c08 | 101 | |
5903019b MCC |
102 | 2) Describe your changes |
103 | ------------------------ | |
1da177e4 | 104 | |
7b9828d4 JW |
105 | Describe your problem. Whether your patch is a one-line bug fix or |
106 | 5000 lines of a new feature, there must be an underlying problem that | |
107 | motivated you to do this work. Convince the reviewer that there is a | |
108 | problem worth fixing and that it makes sense for them to read past the | |
109 | first paragraph. | |
110 | ||
111 | Describe user-visible impact. Straight up crashes and lockups are | |
112 | pretty convincing, but not all bugs are that blatant. Even if the | |
113 | problem was spotted during code review, describe the impact you think | |
114 | it can have on users. Keep in mind that the majority of Linux | |
115 | installations run kernels from secondary stable trees or | |
116 | vendor/product-specific trees that cherry-pick only specific patches | |
117 | from upstream, so include anything that could help route your change | |
118 | downstream: provoking circumstances, excerpts from dmesg, crash | |
119 | descriptions, performance regressions, latency spikes, lockups, etc. | |
120 | ||
121 | Quantify optimizations and trade-offs. If you claim improvements in | |
122 | performance, memory consumption, stack footprint, or binary size, | |
123 | include numbers that back them up. But also describe non-obvious | |
124 | costs. Optimizations usually aren't free but trade-offs between CPU, | |
125 | memory, and readability; or, when it comes to heuristics, between | |
126 | different workloads. Describe the expected downsides of your | |
127 | optimization so that the reviewer can weigh costs against benefits. | |
128 | ||
129 | Once the problem is established, describe what you are actually doing | |
130 | about it in technical detail. It's important to describe the change | |
131 | in plain English for the reviewer to verify that the code is behaving | |
132 | as you intend it to. | |
1da177e4 | 133 | |
2ae19aca TT |
134 | The maintainer will thank you if you write your patch description in a |
135 | form which can be easily pulled into Linux's source code management | |
9b2c7677 | 136 | system, ``git``, as a "commit log". See :ref:`explicit_in_reply_to`. |
2ae19aca | 137 | |
7b9828d4 JW |
138 | Solve only one problem per patch. If your description starts to get |
139 | long, that's a sign that you probably need to split up your patch. | |
5903019b | 140 | See :ref:`split_changes`. |
1da177e4 | 141 | |
d89b1945 RD |
142 | When you submit or resubmit a patch or patch series, include the |
143 | complete patch description and justification for it. Don't just | |
144 | say that this is version N of the patch (series). Don't expect the | |
d00c4559 | 145 | subsystem maintainer to refer back to earlier patch versions or referenced |
d89b1945 RD |
146 | URLs to find the patch description and put that into the patch. |
147 | I.e., the patch (series) and its description should be self-contained. | |
d00c4559 | 148 | This benefits both the maintainers and reviewers. Some reviewers |
d89b1945 RD |
149 | probably didn't even receive earlier versions of the patch. |
150 | ||
74a475ac JT |
151 | Describe your changes in imperative mood, e.g. "make xyzzy do frotz" |
152 | instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy | |
153 | to do frotz", as if you are giving orders to the codebase to change | |
154 | its behaviour. | |
155 | ||
d89b1945 | 156 | If the patch fixes a logged bug entry, refer to that bug entry by |
9547c706 JT |
157 | number and URL. If the patch follows from a mailing list discussion, |
158 | give a URL to the mailing list archive; use the https://lkml.kernel.org/ | |
9b2c7677 | 159 | redirector with a ``Message-Id``, to ensure that the links cannot become |
9547c706 JT |
160 | stale. |
161 | ||
162 | However, try to make your explanation understandable without external | |
163 | resources. In addition to giving a URL to a mailing list archive or | |
164 | bug, summarize the relevant points of the discussion that led to the | |
165 | patch as submitted. | |
1da177e4 | 166 | |
0af52703 GU |
167 | If you want to refer to a specific commit, don't just refer to the |
168 | SHA-1 ID of the commit. Please also include the oneline summary of | |
169 | the commit, to make it easier for reviewers to know what it is about. | |
5903019b | 170 | Example:: |
0af52703 GU |
171 | |
172 | Commit e21d2170f36602ae2708 ("video: remove unnecessary | |
173 | platform_set_drvdata()") removed the unnecessary | |
174 | platform_set_drvdata(), but left the variable "dev" unused, | |
175 | delete it. | |
176 | ||
7994cc15 JC |
177 | You should also be sure to use at least the first twelve characters of the |
178 | SHA-1 ID. The kernel repository holds a *lot* of objects, making | |
179 | collisions with shorter IDs a real possibility. Bear in mind that, even if | |
180 | there is no collision with your six-character ID now, that condition may | |
181 | change five years from now. | |
182 | ||
8401aa1f | 183 | If your patch fixes a bug in a specific commit, e.g. you found an issue using |
9b2c7677 MCC |
184 | ``git bisect``, please use the 'Fixes:' tag with the first 12 characters of |
185 | the SHA-1 ID, and the one line summary. For example:: | |
8401aa1f JK |
186 | |
187 | Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()") | |
188 | ||
9b2c7677 MCC |
189 | The following ``git config`` settings can be used to add a pretty format for |
190 | outputting the above style in the ``git log`` or ``git show`` commands:: | |
8401aa1f JK |
191 | |
192 | [core] | |
193 | abbrev = 12 | |
194 | [pretty] | |
195 | fixes = Fixes: %h (\"%s\") | |
1da177e4 | 196 | |
5903019b MCC |
197 | .. _split_changes: |
198 | ||
199 | 3) Separate your changes | |
200 | ------------------------ | |
1da177e4 | 201 | |
5903019b | 202 | Separate each **logical change** into a separate patch. |
1da177e4 LT |
203 | |
204 | For example, if your changes include both bug fixes and performance | |
205 | enhancements for a single driver, separate those changes into two | |
206 | or more patches. If your changes include an API update, and a new | |
207 | driver which uses that new API, separate those into two patches. | |
208 | ||
209 | On the other hand, if you make a single change to numerous files, | |
210 | group those changes into a single patch. Thus a single logical change | |
211 | is contained within a single patch. | |
212 | ||
d00c4559 JC |
213 | The point to remember is that each patch should make an easily understood |
214 | change that can be verified by reviewers. Each patch should be justifiable | |
215 | on its own merits. | |
216 | ||
1da177e4 | 217 | If one patch depends on another patch in order for a change to be |
5903019b | 218 | complete, that is OK. Simply note **"this patch depends on patch X"** |
1da177e4 LT |
219 | in your patch description. |
220 | ||
7994cc15 JC |
221 | When dividing your change into a series of patches, take special care to |
222 | ensure that the kernel builds and runs properly after each patch in the | |
5903019b | 223 | series. Developers using ``git bisect`` to track down a problem can end up |
7994cc15 JC |
224 | splitting your patch series at any point; they will not thank you if you |
225 | introduce bugs in the middle. | |
226 | ||
5b0ed2c6 XVP |
227 | If you cannot condense your patch set into a smaller set of patches, |
228 | then only post say 15 or so at a time and wait for review and integration. | |
229 | ||
230 | ||
1da177e4 | 231 | |
5903019b MCC |
232 | 4) Style-check your changes |
233 | --------------------------- | |
0a920b5b AW |
234 | |
235 | Check your patch for basic style violations, details of which can be | |
dca22a63 | 236 | found in |
8c27ceff | 237 | :ref:`Documentation/process/coding-style.rst <codingstyle>`. |
dca22a63 | 238 | Failure to do so simply wastes |
f56d35e7 | 239 | the reviewers time and will get your patch rejected, probably |
0a920b5b AW |
240 | without even being read. |
241 | ||
6de16eba JC |
242 | One significant exception is when moving code from one file to |
243 | another -- in this case you should not modify the moved code at all in | |
244 | the same patch which moves it. This clearly delineates the act of | |
245 | moving the code and your changes. This greatly aids review of the | |
246 | actual differences and allows tools to better track the history of | |
247 | the code itself. | |
248 | ||
249 | Check your patches with the patch style checker prior to submission | |
250 | (scripts/checkpatch.pl). Note, though, that the style checker should be | |
251 | viewed as a guide, not as a replacement for human judgment. If your code | |
252 | looks better with a violation then its probably best left alone. | |
0a920b5b | 253 | |
6de16eba JC |
254 | The checker reports at three levels: |
255 | - ERROR: things that are very likely to be wrong | |
256 | - WARNING: things requiring careful review | |
257 | - CHECK: things requiring thought | |
0a920b5b | 258 | |
6de16eba JC |
259 | You should be able to justify all violations that remain in your |
260 | patch. | |
0a920b5b AW |
261 | |
262 | ||
5903019b MCC |
263 | 5) Select the recipients for your patch |
264 | --------------------------------------- | |
1da177e4 | 265 | |
ccae8616 JC |
266 | You should always copy the appropriate subsystem maintainer(s) on any patch |
267 | to code that they maintain; look through the MAINTAINERS file and the | |
268 | source code revision history to see who those maintainers are. The | |
269 | script scripts/get_maintainer.pl can be very useful at this step. If you | |
d6eff078 | 270 | cannot find a maintainer for the subsystem you are working on, Andrew |
ccae8616 | 271 | Morton (akpm@linux-foundation.org) serves as a maintainer of last resort. |
1da177e4 | 272 | |
ccae8616 JC |
273 | You should also normally choose at least one mailing list to receive a copy |
274 | of your patch set. linux-kernel@vger.kernel.org functions as a list of | |
275 | last resort, but the volume on that list has caused a number of developers | |
276 | to tune it out. Look in the MAINTAINERS file for a subsystem-specific | |
277 | list; your patch will probably get more attention there. Please do not | |
278 | spam unrelated lists, though. | |
1da177e4 | 279 | |
ccae8616 JC |
280 | Many kernel-related lists are hosted on vger.kernel.org; you can find a |
281 | list of them at http://vger.kernel.org/vger-lists.html. There are | |
282 | kernel-related lists hosted elsewhere as well, though. | |
5b0ed2c6 XVP |
283 | |
284 | Do not send more than 15 patches at once to the vger mailing lists!!! | |
285 | ||
1da177e4 | 286 | Linus Torvalds is the final arbiter of all changes accepted into the |
e00bfcbf | 287 | Linux kernel. His e-mail address is <torvalds@linux-foundation.org>. |
ccae8616 JC |
288 | He gets a lot of e-mail, and, at this point, very few patches go through |
289 | Linus directly, so typically you should do your best to -avoid- | |
e00bfcbf | 290 | sending him e-mail. |
1da177e4 | 291 | |
ccae8616 JC |
292 | If you have a patch that fixes an exploitable security bug, send that patch |
293 | to security@kernel.org. For severe bugs, a short embargo may be considered | |
253508ca | 294 | to allow distributors to get the patch out to users; in such cases, |
ccae8616 | 295 | obviously, the patch should not be sent to any public lists. |
1da177e4 | 296 | |
ccae8616 | 297 | Patches that fix a severe bug in a released kernel should be directed |
5903019b | 298 | toward the stable maintainers by putting a line like this:: |
1da177e4 | 299 | |
ccae8616 | 300 | Cc: stable@vger.kernel.org |
1da177e4 | 301 | |
8cda4c3a | 302 | into the sign-off area of your patch (note, NOT an email recipient). You |
dca22a63 | 303 | should also read |
8c27ceff | 304 | :ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>` |
dca22a63 | 305 | in addition to this file. |
1da177e4 | 306 | |
ccae8616 JC |
307 | Note, however, that some subsystem maintainers want to come to their own |
308 | conclusions on which patches should go to the stable trees. The networking | |
309 | maintainer, in particular, would rather not see individual developers | |
310 | adding lines like the above to their patches. | |
5b0ed2c6 | 311 | |
ccae8616 JC |
312 | If changes affect userland-kernel interfaces, please send the MAN-PAGES |
313 | maintainer (as listed in the MAINTAINERS file) a man-pages patch, or at | |
314 | least a notification of the change, so that some information makes its way | |
315 | into the manual pages. User-space API changes should also be copied to | |
5903019b | 316 | linux-api@vger.kernel.org. |
1da177e4 LT |
317 | |
318 | For small patches you may want to CC the Trivial Patch Monkey | |
82d27b2b MH |
319 | trivial@kernel.org which collects "trivial" patches. Have a look |
320 | into the MAINTAINERS file for its current manager. | |
5903019b | 321 | |
82d27b2b | 322 | Trivial patches must qualify for one of the following rules: |
5903019b | 323 | |
9b2c7677 MCC |
324 | - Spelling fixes in documentation |
325 | - Spelling fixes for errors which could break :manpage:`grep(1)` | |
326 | - Warning fixes (cluttering with useless warnings is bad) | |
327 | - Compilation fixes (only if they are actually correct) | |
328 | - Runtime fixes (only if they actually fix things) | |
329 | - Removing use of deprecated functions/macros | |
330 | - Contact detail and documentation fixes | |
331 | - Non-portable code replaced by portable code (even in arch-specific, | |
332 | since people copy, as long as it's trivial) | |
333 | - Any fix by the author/maintainer of the file (ie. patch monkey | |
334 | in re-transmission mode) | |
84da7c08 | 335 | |
1da177e4 LT |
336 | |
337 | ||
5903019b MCC |
338 | 6) No MIME, no links, no compression, no attachments. Just plain text |
339 | ---------------------------------------------------------------------- | |
1da177e4 LT |
340 | |
341 | Linus and other kernel developers need to be able to read and comment | |
342 | on the changes you are submitting. It is important for a kernel | |
343 | developer to be able to "quote" your changes, using standard e-mail | |
344 | tools, so that they may comment on specific portions of your code. | |
345 | ||
bdc89213 | 346 | For this reason, all patches should be submitted by e-mail "inline". |
9b2c7677 MCC |
347 | |
348 | .. warning:: | |
349 | ||
350 | Be wary of your editor's word-wrap corrupting your patch, | |
351 | if you choose to cut-n-paste your patch. | |
1da177e4 LT |
352 | |
353 | Do not attach the patch as a MIME attachment, compressed or not. | |
354 | Many popular e-mail applications will not always transmit a MIME | |
355 | attachment as plain text, making it impossible to comment on your | |
356 | code. A MIME attachment also takes Linus a bit more time to process, | |
357 | decreasing the likelihood of your MIME-attached change being accepted. | |
358 | ||
359 | Exception: If your mailer is mangling patches then someone may ask | |
360 | you to re-send them using MIME. | |
361 | ||
8c27ceff | 362 | See :ref:`Documentation/process/email-clients.rst <email_clients>` |
dca22a63 MCC |
363 | for hints about configuring your e-mail client so that it sends your patches |
364 | untouched. | |
1da177e4 | 365 | |
5903019b MCC |
366 | 7) E-mail size |
367 | -------------- | |
1da177e4 LT |
368 | |
369 | Large changes are not appropriate for mailing lists, and some | |
4932be77 | 370 | maintainers. If your patch, uncompressed, exceeds 300 kB in size, |
1da177e4 | 371 | it is preferred that you store your patch on an Internet-accessible |
d00c4559 JC |
372 | server, and provide instead a URL (link) pointing to your patch. But note |
373 | that if your patch exceeds 300 kB, it almost certainly needs to be broken up | |
374 | anyway. | |
1da177e4 | 375 | |
5903019b MCC |
376 | 8) Respond to review comments |
377 | ----------------------------- | |
1da177e4 | 378 | |
0eea2314 JC |
379 | Your patch will almost certainly get comments from reviewers on ways in |
380 | which the patch can be improved. You must respond to those comments; | |
381 | ignoring reviewers is a good way to get ignored in return. Review comments | |
382 | or questions that do not lead to a code change should almost certainly | |
383 | bring about a comment or changelog entry so that the next reviewer better | |
384 | understands what is going on. | |
1da177e4 | 385 | |
0eea2314 JC |
386 | Be sure to tell the reviewers what changes you are making and to thank them |
387 | for their time. Code review is a tiring and time-consuming process, and | |
388 | reviewers sometimes get grumpy. Even in that case, though, respond | |
389 | politely and address the problems they have pointed out. | |
1da177e4 | 390 | |
1da177e4 | 391 | |
5903019b MCC |
392 | 9) Don't get discouraged - or impatient |
393 | --------------------------------------- | |
1da177e4 | 394 | |
0eea2314 JC |
395 | After you have submitted your change, be patient and wait. Reviewers are |
396 | busy people and may not get to your patch right away. | |
1da177e4 | 397 | |
0eea2314 JC |
398 | Once upon a time, patches used to disappear into the void without comment, |
399 | but the development process works more smoothly than that now. You should | |
400 | receive comments within a week or so; if that does not happen, make sure | |
401 | that you have sent your patches to the right place. Wait for a minimum of | |
402 | one week before resubmitting or pinging reviewers - possibly longer during | |
403 | busy times like merge windows. | |
1da177e4 | 404 | |
1da177e4 | 405 | |
ccae8616 | 406 | 10) Include PATCH in the subject |
d00c4559 | 407 | -------------------------------- |
1da177e4 LT |
408 | |
409 | Due to high e-mail traffic to Linus, and to linux-kernel, it is common | |
410 | convention to prefix your subject line with [PATCH]. This lets Linus | |
411 | and other kernel developers more easily distinguish patches from other | |
412 | e-mail discussions. | |
413 | ||
414 | ||
415 | ||
89edeedd JC |
416 | 11) Sign your work — the Developer's Certificate of Origin |
417 | ---------------------------------------------------------- | |
1da177e4 LT |
418 | |
419 | To improve tracking of who did what, especially with patches that can | |
420 | percolate to their final resting place in the kernel through several | |
421 | layers of maintainers, we've introduced a "sign-off" procedure on | |
422 | patches that are being emailed around. | |
423 | ||
424 | The sign-off is a simple line at the end of the explanation for the | |
425 | patch, which certifies that you wrote it or otherwise have the right to | |
db12fb83 | 426 | pass it on as an open-source patch. The rules are pretty simple: if you |
1da177e4 LT |
427 | can certify the below: |
428 | ||
5903019b MCC |
429 | Developer's Certificate of Origin 1.1 |
430 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1da177e4 | 431 | |
5903019b | 432 | By making a contribution to this project, I certify that: |
1da177e4 LT |
433 | |
434 | (a) The contribution was created in whole or in part by me and I | |
435 | have the right to submit it under the open source license | |
436 | indicated in the file; or | |
437 | ||
438 | (b) The contribution is based upon previous work that, to the best | |
439 | of my knowledge, is covered under an appropriate open source | |
440 | license and I have the right under that license to submit that | |
441 | work with modifications, whether created in whole or in part | |
442 | by me, under the same open source license (unless I am | |
443 | permitted to submit under a different license), as indicated | |
444 | in the file; or | |
445 | ||
446 | (c) The contribution was provided directly to me by some other | |
447 | person who certified (a), (b) or (c) and I have not modified | |
448 | it. | |
449 | ||
e00bfcbf SB |
450 | (d) I understand and agree that this project and the contribution |
451 | are public and that a record of the contribution (including all | |
452 | personal information I submit with it, including my sign-off) is | |
453 | maintained indefinitely and may be redistributed consistent with | |
454 | this project or the open source license(s) involved. | |
cbd83da8 | 455 | |
5903019b | 456 | then you just add a line saying:: |
1da177e4 | 457 | |
9fd5559c | 458 | Signed-off-by: Random J Developer <random@developer.example.org> |
1da177e4 | 459 | |
af45f32d GKH |
460 | using your real name (sorry, no pseudonyms or anonymous contributions.) |
461 | ||
1da177e4 LT |
462 | Some people also put extra tags at the end. They'll just be ignored for |
463 | now, but you can do this to mark internal company procedures or just | |
e00bfcbf | 464 | point out some special detail about the sign-off. |
1da177e4 | 465 | |
adbd5886 WT |
466 | If you are a subsystem or branch maintainer, sometimes you need to slightly |
467 | modify patches you receive in order to merge them, because the code is not | |
468 | exactly the same in your tree and the submitters'. If you stick strictly to | |
469 | rule (c), you should ask the submitter to rediff, but this is a totally | |
470 | counter-productive waste of time and energy. Rule (b) allows you to adjust | |
471 | the code, but then it is very impolite to change one submitter's code and | |
472 | make him endorse your bugs. To solve this problem, it is recommended that | |
473 | you add a line between the last Signed-off-by header and yours, indicating | |
474 | the nature of your changes. While there is nothing mandatory about this, it | |
475 | seems like prepending the description with your mail and/or name, all | |
476 | enclosed in square brackets, is noticeable enough to make it obvious that | |
5903019b | 477 | you are responsible for last-minute changes. Example:: |
adbd5886 WT |
478 | |
479 | Signed-off-by: Random J Developer <random@developer.example.org> | |
480 | [lucky@maintainer.example.org: struct foo moved from foo.c to foo.h] | |
481 | Signed-off-by: Lucky K Maintainer <lucky@maintainer.example.org> | |
482 | ||
305af08c | 483 | This practice is particularly helpful if you maintain a stable branch and |
adbd5886 WT |
484 | want at the same time to credit the author, track changes, merge the fix, |
485 | and protect the submitter from complaints. Note that under no circumstances | |
486 | can you change the author's identity (the From header), as it is the one | |
487 | which appears in the changelog. | |
488 | ||
305af08c | 489 | Special note to back-porters: It seems to be a common and useful practice |
adbd5886 WT |
490 | to insert an indication of the origin of a patch at the top of the commit |
491 | message (just after the subject line) to facilitate tracking. For instance, | |
5903019b | 492 | here's what we see in a 3.x-stable release:: |
adbd5886 | 493 | |
5903019b | 494 | Date: Tue Oct 7 07:26:38 2014 -0400 |
adbd5886 | 495 | |
7994cc15 | 496 | libata: Un-break ATA blacklist |
adbd5886 | 497 | |
7994cc15 | 498 | commit 1c40279960bcd7d52dbdf1d466b20d24b99176c8 upstream. |
adbd5886 | 499 | |
5903019b | 500 | And here's what might appear in an older kernel once a patch is backported:: |
adbd5886 WT |
501 | |
502 | Date: Tue May 13 22:12:27 2008 +0200 | |
503 | ||
504 | wireless, airo: waitbusy() won't delay | |
505 | ||
506 | [backport of 2.6 commit b7acbdfbd1f277c1eb23f344f899cfa4cd0bf36a] | |
507 | ||
508 | Whatever the format, this information provides a valuable help to people | |
7994cc15 | 509 | tracking your trees, and to people trying to troubleshoot bugs in your |
adbd5886 WT |
510 | tree. |
511 | ||
1da177e4 | 512 | |
ccae8616 | 513 | 12) When to use Acked-by: and Cc: |
d00c4559 | 514 | --------------------------------- |
0a920b5b | 515 | |
0f44cd23 AM |
516 | The Signed-off-by: tag indicates that the signer was involved in the |
517 | development of the patch, or that he/she was in the patch's delivery path. | |
518 | ||
519 | If a person was not directly involved in the preparation or handling of a | |
520 | patch but wishes to signify and record their approval of it then they can | |
d00c4559 | 521 | ask to have an Acked-by: line added to the patch's changelog. |
0f44cd23 AM |
522 | |
523 | Acked-by: is often used by the maintainer of the affected code when that | |
524 | maintainer neither contributed to nor forwarded the patch. | |
525 | ||
526 | Acked-by: is not as formal as Signed-off-by:. It is a record that the acker | |
527 | has at least reviewed the patch and has indicated acceptance. Hence patch | |
528 | mergers will sometimes manually convert an acker's "yep, looks good to me" | |
d00c4559 JC |
529 | into an Acked-by: (but note that it is usually better to ask for an |
530 | explicit ack). | |
0f44cd23 AM |
531 | |
532 | Acked-by: does not necessarily indicate acknowledgement of the entire patch. | |
533 | For example, if a patch affects multiple subsystems and has an Acked-by: from | |
534 | one subsystem maintainer then this usually indicates acknowledgement of just | |
535 | the part which affects that maintainer's code. Judgement should be used here. | |
ef40203a | 536 | When in doubt people should refer to the original discussion in the mailing |
0f44cd23 AM |
537 | list archives. |
538 | ||
ef40203a | 539 | If a person has had the opportunity to comment on a patch, but has not |
5903019b | 540 | provided such comments, you may optionally add a ``Cc:`` tag to the patch. |
ef40203a | 541 | This is the only tag which might be added without an explicit action by the |
d00c4559 JC |
542 | person it names - but it should indicate that this person was copied on the |
543 | patch. This tag documents that potentially interested parties | |
544 | have been included in the discussion. | |
0f44cd23 | 545 | |
ef40203a | 546 | |
ccae8616 | 547 | 13) Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: |
d00c4559 | 548 | -------------------------------------------------------------------------- |
bbb0a424 | 549 | |
d75ef707 DC |
550 | The Reported-by tag gives credit to people who find bugs and report them and it |
551 | hopefully inspires them to help us again in the future. Please note that if | |
552 | the bug was reported in private, then ask for permission first before using the | |
553 | Reported-by tag. | |
ef40203a JC |
554 | |
555 | A Tested-by: tag indicates that the patch has been successfully tested (in | |
556 | some environment) by the person named. This tag informs maintainers that | |
557 | some testing has been performed, provides a means to locate testers for | |
558 | future patches, and ensures credit for the testers. | |
559 | ||
560 | Reviewed-by:, instead, indicates that the patch has been reviewed and found | |
561 | acceptable according to the Reviewer's Statement: | |
562 | ||
5903019b MCC |
563 | Reviewer's statement of oversight |
564 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
ef40203a | 565 | |
5903019b | 566 | By offering my Reviewed-by: tag, I state that: |
ef40203a | 567 | |
5903019b | 568 | (a) I have carried out a technical review of this patch to |
ef40203a JC |
569 | evaluate its appropriateness and readiness for inclusion into |
570 | the mainline kernel. | |
571 | ||
572 | (b) Any problems, concerns, or questions relating to the patch | |
573 | have been communicated back to the submitter. I am satisfied | |
574 | with the submitter's response to my comments. | |
575 | ||
576 | (c) While there may be things that could be improved with this | |
577 | submission, I believe that it is, at this time, (1) a | |
578 | worthwhile modification to the kernel, and (2) free of known | |
579 | issues which would argue against its inclusion. | |
580 | ||
581 | (d) While I have reviewed the patch and believe it to be sound, I | |
582 | do not (unless explicitly stated elsewhere) make any | |
583 | warranties or guarantees that it will achieve its stated | |
584 | purpose or function properly in any given situation. | |
585 | ||
586 | A Reviewed-by tag is a statement of opinion that the patch is an | |
587 | appropriate modification of the kernel without any remaining serious | |
588 | technical issues. Any interested reviewer (who has done the work) can | |
589 | offer a Reviewed-by tag for a patch. This tag serves to give credit to | |
590 | reviewers and to inform maintainers of the degree of review which has been | |
591 | done on the patch. Reviewed-by: tags, when supplied by reviewers known to | |
592 | understand the subject area and to perform thorough reviews, will normally | |
5801da1b | 593 | increase the likelihood of your patch getting into the kernel. |
ef40203a | 594 | |
8543ae12 M |
595 | A Suggested-by: tag indicates that the patch idea is suggested by the person |
596 | named and ensures credit to the person for the idea. Please note that this | |
597 | tag should not be added without the reporter's permission, especially if the | |
598 | idea was not posted in a public forum. That said, if we diligently credit our | |
599 | idea reporters, they will, hopefully, be inspired to help us again in the | |
600 | future. | |
601 | ||
8401aa1f JK |
602 | A Fixes: tag indicates that the patch fixes an issue in a previous commit. It |
603 | is used to make it easy to determine where a bug originated, which can help | |
604 | review a bug fix. This tag also assists the stable kernel team in determining | |
605 | which stable kernel versions should receive your fix. This is the preferred | |
5903019b MCC |
606 | method for indicating a bug fixed by the patch. See :ref:`describe_changes` |
607 | for more details. | |
8401aa1f | 608 | |
ef40203a | 609 | |
ccae8616 | 610 | 14) The canonical patch format |
7994cc15 JC |
611 | ------------------------------ |
612 | ||
613 | This section describes how the patch itself should be formatted. Note | |
9b2c7677 | 614 | that, if you have your patches stored in a ``git`` repository, proper patch |
5903019b | 615 | formatting can be had with ``git format-patch``. The tools cannot create |
7994cc15 | 616 | the necessary text, though, so read the instructions below anyway. |
84da7c08 | 617 | |
5903019b | 618 | The canonical patch subject line is:: |
75f8426c | 619 | |
d6b9acc0 | 620 | Subject: [PATCH 001/123] subsystem: summary phrase |
75f8426c PJ |
621 | |
622 | The canonical patch message body contains the following: | |
623 | ||
5903019b | 624 | - A ``from`` line specifying the patch author (only needed if the person |
ccae8616 | 625 | sending the patch is not the author). |
75f8426c PJ |
626 | |
627 | - An empty line. | |
628 | ||
2a076f40 JP |
629 | - The body of the explanation, line wrapped at 75 columns, which will |
630 | be copied to the permanent changelog to describe this patch. | |
75f8426c | 631 | |
5903019b | 632 | - The ``Signed-off-by:`` lines, described above, which will |
75f8426c PJ |
633 | also go in the changelog. |
634 | ||
5903019b | 635 | - A marker line containing simply ``---``. |
75f8426c PJ |
636 | |
637 | - Any additional comments not suitable for the changelog. | |
638 | ||
9b2c7677 | 639 | - The actual patch (``diff`` output). |
75f8426c PJ |
640 | |
641 | The Subject line format makes it very easy to sort the emails | |
642 | alphabetically by subject line - pretty much any email reader will | |
643 | support that - since because the sequence number is zero-padded, | |
644 | the numerical and alphabetic sort is the same. | |
645 | ||
5903019b | 646 | The ``subsystem`` in the email's Subject should identify which |
d6b9acc0 PJ |
647 | area or subsystem of the kernel is being patched. |
648 | ||
5903019b MCC |
649 | The ``summary phrase`` in the email's Subject should concisely |
650 | describe the patch which that email contains. The ``summary | |
651 | phrase`` should not be a filename. Do not use the same ``summary | |
652 | phrase`` for every patch in a whole patch series (where a ``patch | |
653 | series`` is an ordered sequence of multiple, related patches). | |
d6b9acc0 | 654 | |
5903019b | 655 | Bear in mind that the ``summary phrase`` of your email becomes a |
2ae19aca | 656 | globally-unique identifier for that patch. It propagates all the way |
9b2c7677 | 657 | into the ``git`` changelog. The ``summary phrase`` may later be used in |
2ae19aca | 658 | developer discussions which refer to the patch. People will want to |
5903019b | 659 | google for the ``summary phrase`` to read discussion regarding that |
2ae19aca TT |
660 | patch. It will also be the only thing that people may quickly see |
661 | when, two or three months later, they are going through perhaps | |
9b2c7677 MCC |
662 | thousands of patches using tools such as ``gitk`` or ``git log |
663 | --oneline``. | |
2ae19aca | 664 | |
5903019b | 665 | For these reasons, the ``summary`` must be no more than 70-75 |
2ae19aca TT |
666 | characters, and it must describe both what the patch changes, as well |
667 | as why the patch might be necessary. It is challenging to be both | |
668 | succinct and descriptive, but that is what a well-written summary | |
669 | should do. | |
670 | ||
5903019b | 671 | The ``summary phrase`` may be prefixed by tags enclosed in square |
e12d7462 AH |
672 | brackets: "Subject: [PATCH <tag>...] <summary phrase>". The tags are |
673 | not considered part of the summary phrase, but describe how the patch | |
2ae19aca TT |
674 | should be treated. Common tags might include a version descriptor if |
675 | the multiple versions of the patch have been sent out in response to | |
676 | comments (i.e., "v1, v2, v3"), or "RFC" to indicate a request for | |
677 | comments. If there are four patches in a patch series the individual | |
678 | patches may be numbered like this: 1/4, 2/4, 3/4, 4/4. This assures | |
679 | that developers understand the order in which the patches should be | |
680 | applied and that they have reviewed or applied all of the patches in | |
681 | the patch series. | |
d6b9acc0 | 682 | |
5903019b | 683 | A couple of example Subjects:: |
d6b9acc0 | 684 | |
e12d7462 AH |
685 | Subject: [PATCH 2/5] ext2: improve scalability of bitmap searching |
686 | Subject: [PATCH v2 01/27] x86: fix eflags tracking | |
75f8426c | 687 | |
5903019b | 688 | The ``from`` line must be the very first line in the message body, |
75f8426c PJ |
689 | and has the form: |
690 | ||
691 | From: Original Author <author@example.com> | |
692 | ||
5903019b MCC |
693 | The ``from`` line specifies who will be credited as the author of the |
694 | patch in the permanent changelog. If the ``from`` line is missing, | |
695 | then the ``From:`` line from the email header will be used to determine | |
75f8426c PJ |
696 | the patch author in the changelog. |
697 | ||
698 | The explanation body will be committed to the permanent source | |
699 | changelog, so should make sense to a competent reader who has long | |
700 | since forgotten the immediate details of the discussion that might | |
2ae19aca TT |
701 | have led to this patch. Including symptoms of the failure which the |
702 | patch addresses (kernel log messages, oops messages, etc.) is | |
703 | especially useful for people who might be searching the commit logs | |
704 | looking for the applicable patch. If a patch fixes a compile failure, | |
705 | it may not be necessary to include _all_ of the compile failures; just | |
706 | enough that it is likely that someone searching for the patch can find | |
5903019b | 707 | it. As in the ``summary phrase``, it is important to be both succinct as |
2ae19aca | 708 | well as descriptive. |
75f8426c | 709 | |
5903019b | 710 | The ``---`` marker line serves the essential purpose of marking for patch |
75f8426c PJ |
711 | handling tools where the changelog message ends. |
712 | ||
5903019b | 713 | One good use for the additional comments after the ``---`` marker is for |
9b2c7677 MCC |
714 | a ``diffstat``, to show what files have changed, and the number of |
715 | inserted and deleted lines per file. A ``diffstat`` is especially useful | |
2ae19aca TT |
716 | on bigger patches. Other comments relevant only to the moment or the |
717 | maintainer, not suitable for the permanent changelog, should also go | |
5903019b | 718 | here. A good example of such comments might be ``patch changelogs`` |
2ae19aca TT |
719 | which describe what has changed between the v1 and v2 version of the |
720 | patch. | |
721 | ||
9b2c7677 MCC |
722 | If you are going to include a ``diffstat`` after the ``---`` marker, please |
723 | use ``diffstat`` options ``-p 1 -w 70`` so that filenames are listed from | |
2ae19aca | 724 | the top of the kernel source tree and don't use too much horizontal |
9b2c7677 | 725 | space (easily fit in 80 columns, maybe with some indentation). (``git`` |
8e3072a2 | 726 | generates appropriate diffstats by default.) |
75f8426c PJ |
727 | |
728 | See more details on the proper patch format in the following | |
729 | references. | |
730 | ||
5903019b MCC |
731 | .. _explicit_in_reply_to: |
732 | ||
d7ac8d85 CM |
733 | 15) Explicit In-Reply-To headers |
734 | -------------------------------- | |
735 | ||
736 | It can be helpful to manually add In-Reply-To: headers to a patch | |
5903019b | 737 | (e.g., when using ``git send-email``) to associate the patch with |
d7ac8d85 CM |
738 | previous relevant discussion, e.g. to link a bug fix to the email with |
739 | the bug report. However, for a multi-patch series, it is generally | |
740 | best to avoid using In-Reply-To: to link to older versions of the | |
741 | series. This way multiple versions of the patch don't become an | |
742 | unmanageable forest of references in email clients. If a link is | |
743 | helpful, you can use the https://lkml.kernel.org/ redirector (e.g., in | |
744 | the cover email text) to link to an earlier version of the patch series. | |
745 | ||
75f8426c | 746 | |
5903019b MCC |
747 | 16) Sending ``git pull`` requests |
748 | --------------------------------- | |
1da177e4 | 749 | |
7994cc15 JC |
750 | If you have a series of patches, it may be most convenient to have the |
751 | maintainer pull them directly into the subsystem repository with a | |
5903019b | 752 | ``git pull`` operation. Note, however, that pulling patches from a developer |
7994cc15 JC |
753 | requires a higher degree of trust than taking patches from a mailing list. |
754 | As a result, many subsystem maintainers are reluctant to take pull | |
b792ffe4 JC |
755 | requests, especially from new, unknown developers. If in doubt you can use |
756 | the pull request as the cover letter for a normal posting of the patch | |
757 | series, giving the maintainer the option of using either. | |
1da177e4 | 758 | |
7994cc15 JC |
759 | A pull request should have [GIT] or [PULL] in the subject line. The |
760 | request itself should include the repository name and the branch of | |
5903019b | 761 | interest on a single line; it should look something like:: |
1da177e4 | 762 | |
7994cc15 | 763 | Please pull from |
1da177e4 | 764 | |
7994cc15 | 765 | git://jdelvare.pck.nerim.net/jdelvare-2.6 i2c-for-linus |
1da177e4 | 766 | |
64e32895 | 767 | to get these changes: |
1da177e4 | 768 | |
7994cc15 | 769 | A pull request should also include an overall message saying what will be |
5903019b | 770 | included in the request, a ``git shortlog`` listing of the patches |
9b2c7677 | 771 | themselves, and a ``diffstat`` showing the overall effect of the patch series. |
7994cc15 | 772 | The easiest way to get all this information together is, of course, to let |
9b2c7677 | 773 | ``git`` do it for you with the ``git request-pull`` command. |
1da177e4 | 774 | |
7994cc15 JC |
775 | Some maintainers (including Linus) want to see pull requests from signed |
776 | commits; that increases their confidence that the request actually came | |
777 | from you. Linus, in particular, will not pull from public hosting sites | |
778 | like GitHub in the absence of a signed tag. | |
1da177e4 | 779 | |
7994cc15 JC |
780 | The first step toward creating such tags is to make a GNUPG key and get it |
781 | signed by one or more core kernel developers. This step can be hard for | |
782 | new developers, but there is no way around it. Attending conferences can | |
783 | be a good way to find developers who can sign your key. | |
1da177e4 | 784 | |
9b2c7677 | 785 | Once you have prepared a patch series in ``git`` that you wish to have somebody |
5903019b | 786 | pull, create a signed tag with ``git tag -s``. This will create a new tag |
7994cc15 JC |
787 | identifying the last commit in the series and containing a signature |
788 | created with your private key. You will also have the opportunity to add a | |
789 | changelog-style message to the tag; this is an ideal place to describe the | |
790 | effects of the pull request as a whole. | |
1da177e4 | 791 | |
7994cc15 JC |
792 | If the tree the maintainer will be pulling from is not the repository you |
793 | are working from, don't forget to push the signed tag explicitly to the | |
794 | public tree. | |
1da177e4 | 795 | |
7994cc15 | 796 | When generating your pull request, use the signed tag as the target. A |
5903019b | 797 | command like this will do the trick:: |
1da177e4 | 798 | |
7994cc15 | 799 | git request-pull master git://my.public.tree/linux.git my-signed-tag |
5b0ed2c6 XVP |
800 | |
801 | ||
89edeedd JC |
802 | References |
803 | ---------- | |
5b0ed2c6 XVP |
804 | |
805 | Andrew Morton, "The perfect patch" (tpp). | |
37c703f4 | 806 | <http://www.ozlabs.org/~akpm/stuff/tpp.txt> |
5b0ed2c6 | 807 | |
8e9cb8fd | 808 | Jeff Garzik, "Linux kernel patch submission format". |
5b0ed2c6 XVP |
809 | <http://linux.yyz.us/patch-format.html> |
810 | ||
8e9cb8fd | 811 | Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer". |
f5039935 | 812 | <http://www.kroah.com/log/linux/maintainer.html> |
9b2c7677 | 813 | |
f5039935 | 814 | <http://www.kroah.com/log/linux/maintainer-02.html> |
9b2c7677 | 815 | |
f5039935 | 816 | <http://www.kroah.com/log/linux/maintainer-03.html> |
9b2c7677 | 817 | |
f5039935 | 818 | <http://www.kroah.com/log/linux/maintainer-04.html> |
9b2c7677 | 819 | |
f5039935 | 820 | <http://www.kroah.com/log/linux/maintainer-05.html> |
9b2c7677 | 821 | |
7e0dae61 | 822 | <http://www.kroah.com/log/linux/maintainer-06.html> |
5b0ed2c6 | 823 | |
bc7455fa | 824 | NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people! |
37c703f4 | 825 | <https://lkml.org/lkml/2005/7/11/336> |
5b0ed2c6 | 826 | |
8c27ceff MCC |
827 | Kernel Documentation/process/coding-style.rst: |
828 | :ref:`Documentation/process/coding-style.rst <codingstyle>` | |
5b0ed2c6 | 829 | |
8e9cb8fd | 830 | Linus Torvalds's mail on the canonical patch format: |
5b0ed2c6 | 831 | <http://lkml.org/lkml/2005/4/7/183> |
9536727e AK |
832 | |
833 | Andi Kleen, "On submitting kernel patches" | |
25985edc | 834 | Some strategies to get difficult or controversial changes in. |
9b2c7677 | 835 | |
9536727e | 836 | http://halobates.de/on-submitting-patches.pdf |