blob: c74e73c37dcc536831d588fc5236810a0d963e66 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2 How to Get Your Change Into the Linux Kernel
3 or
4 Care And Operation Of Your Linus Torvalds
5
6
7
8For a person or company who wishes to submit a change to the Linux
9kernel, the process can sometimes be daunting if you're not familiar
10with "the system." This text is a collection of suggestions which
11can greatly increase the chances of your change being accepted.
12
Randy Dunlapbc7455f2006-07-30 03:03:45 -070013Read Documentation/SubmitChecklist for a list of items to check
14before submitting code. If you are submitting a driver, also read
15Documentation/SubmittingDrivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
17
18
19--------------------------------------------
20SECTION 1 - CREATING AND SENDING YOUR CHANGE
21--------------------------------------------
22
23
24
251) "diff -up"
26------------
27
28Use "diff -up" or "diff -uprN" to create patches.
29
30All changes to the Linux kernel occur in the form of patches, as
31generated by diff(1). When creating your patch, make sure to create it
32in "unified diff" format, as supplied by the '-u' argument to diff(1).
33Also, please use the '-p' argument which shows which C function each
34change is in - that makes the resultant diff a lot easier to read.
35Patches should be based in the root kernel source directory,
36not in any lower subdirectory.
37
38To create a patch for a single file, it is often sufficient to do:
39
Randy Dunlap84da7c02005-06-28 20:45:30 -070040 SRCTREE= linux-2.6
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 MYFILE= drivers/net/mydriver.c
42
43 cd $SRCTREE
44 cp $MYFILE $MYFILE.orig
45 vi $MYFILE # make your change
46 cd ..
47 diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch
48
49To create a patch for multiple files, you should unpack a "vanilla",
50or unmodified kernel source tree, and generate a diff against your
51own source tree. For example:
52
Randy Dunlap84da7c02005-06-28 20:45:30 -070053 MYSRC= /devel/linux-2.6
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Randy Dunlap84da7c02005-06-28 20:45:30 -070055 tar xvfz linux-2.6.12.tar.gz
56 mv linux-2.6.12 linux-2.6.12-vanilla
57 diff -uprN -X linux-2.6.12-vanilla/Documentation/dontdiff \
58 linux-2.6.12-vanilla $MYSRC > /tmp/patch
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60"dontdiff" is a list of files which are generated by the kernel during
61the build process, and should be ignored in any diff(1)-generated
Randy Dunlap84da7c02005-06-28 20:45:30 -070062patch. The "dontdiff" file is included in the kernel tree in
Randy Dunlap755727b2013-03-08 12:43:35 -0800632.6.12 and later.
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65Make sure your patch does not include any extra files which do not
66belong in a patch submission. Make sure to review your patch -after-
67generated it with diff(1), to ensure accuracy.
68
69If your changes produce a lot of deltas, you may want to look into
70splitting them into individual patches which modify things in
Randy Dunlap84da7c02005-06-28 20:45:30 -070071logical stages. This will facilitate easier reviewing by other
Linus Torvalds1da177e2005-04-16 15:20:36 -070072kernel developers, very important if you want your patch accepted.
Randy Dunlap84da7c02005-06-28 20:45:30 -070073There are a number of scripts which can aid in this:
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75Quilt:
76http://savannah.nongnu.org/projects/quilt
77
Linus Torvalds1da177e2005-04-16 15:20:36 -070078Andrew Morton's patch scripts:
FD Cami2223c652008-10-15 22:02:00 -070079http://userweb.kernel.org/~akpm/stuff/patch-scripts.tar.gz
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -080080Instead of these scripts, quilt is the recommended patch management
81tool (see above).
Randy Dunlap84da7c02005-06-28 20:45:30 -070082
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
852) Describe your changes.
86
87Describe the technical detail of the change(s) your patch includes.
88
89Be as specific as possible. The WORST descriptions possible include
90things like "update driver X", "bug fix for driver X", or "this patch
91includes updates for subsystem X. Please apply."
92
Theodore Ts'o2ae19aca2009-04-16 07:44:45 -040093The maintainer will thank you if you write your patch description in a
94form which can be easily pulled into Linux's source code management
95system, git, as a "commit log". See #15, below.
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097If your description starts to get long, that's a sign that you probably
98need to split up your patch. See #3, next.
99
Randy Dunlapd89b1942010-08-09 17:20:21 -0700100When you submit or resubmit a patch or patch series, include the
101complete patch description and justification for it. Don't just
102say that this is version N of the patch (series). Don't expect the
103patch merger to refer back to earlier patch versions or referenced
104URLs to find the patch description and put that into the patch.
105I.e., the patch (series) and its description should be self-contained.
106This benefits both the patch merger(s) and reviewers. Some reviewers
107probably didn't even receive earlier versions of the patch.
108
Josh Triplett74a475a2014-04-03 14:48:28 -0700109Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
110instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
111to do frotz", as if you are giving orders to the codebase to change
112its behaviour.
113
Randy Dunlapd89b1942010-08-09 17:20:21 -0700114If the patch fixes a logged bug entry, refer to that bug entry by
115number and URL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Geert Uytterhoeven0af52702013-07-31 14:59:38 -0700117If you want to refer to a specific commit, don't just refer to the
118SHA-1 ID of the commit. Please also include the oneline summary of
119the commit, to make it easier for reviewers to know what it is about.
120Example:
121
122 Commit e21d2170f36602ae2708 ("video: remove unnecessary
123 platform_set_drvdata()") removed the unnecessary
124 platform_set_drvdata(), but left the variable "dev" unused,
125 delete it.
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
1283) Separate your changes.
129
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800130Separate _logical changes_ into a single patch file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132For example, if your changes include both bug fixes and performance
133enhancements for a single driver, separate those changes into two
134or more patches. If your changes include an API update, and a new
135driver which uses that new API, separate those into two patches.
136
137On the other hand, if you make a single change to numerous files,
138group those changes into a single patch. Thus a single logical change
139is contained within a single patch.
140
141If one patch depends on another patch in order for a change to be
142complete, that is OK. Simply note "this patch depends on patch X"
143in your patch description.
144
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800145If you cannot condense your patch set into a smaller set of patches,
146then only post say 15 or so at a time and wait for review and integration.
147
148
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001504) Style check your changes.
151
152Check your patch for basic style violations, details of which can be
153found in Documentation/CodingStyle. Failure to do so simply wastes
Linus Nilssonf56d35e2007-07-21 17:49:06 +0200154the reviewers time and will get your patch rejected, probably
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700155without even being read.
156
157At a minimum you should check your patches with the patch style
Andre Haupta570ab62007-09-11 15:23:47 -0700158checker prior to submission (scripts/checkpatch.pl). You should
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700159be able to justify all violations that remain in your patch.
160
161
162
1635) Select e-mail destination.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
165Look through the MAINTAINERS file and the source code, and determine
166if your change applies to a specific subsystem of the kernel, with
Michel Machadoe52d2e12012-04-02 22:10:53 -0400167an assigned maintainer. If so, e-mail that person. The script
168scripts/get_maintainer.pl can be very useful at this step.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170If no maintainer is listed, or the maintainer does not respond, send
171your patch to the primary Linux kernel developer's mailing list,
172linux-kernel@vger.kernel.org. Most kernel developers monitor this
173e-mail list, and can comment on your changes.
174
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800175
176Do not send more than 15 patches at once to the vger mailing lists!!!
177
178
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179Linus Torvalds is the final arbiter of all changes accepted into the
Linus Torvalds99ddcc72007-01-23 14:22:35 -0800180Linux kernel. His e-mail address is <torvalds@linux-foundation.org>.
181He gets a lot of e-mail, so typically you should do your best to -avoid-
182sending him e-mail.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184Patches which are bug fixes, are "obvious" changes, or similarly
185require little discussion should be sent or CC'd to Linus. Patches
186which require discussion or do not have a clear advantage should
187usually be sent first to linux-kernel. Only after the patch is
188discussed should the patch then be submitted to Linus.
189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
191
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001926) Select your CC (e-mail carbon copy) list.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194Unless you have a reason NOT to do so, CC linux-kernel@vger.kernel.org.
195
196Other kernel developers besides Linus need to be aware of your change,
197so that they may comment on it and offer code review and suggestions.
198linux-kernel is the primary Linux kernel developer mailing list.
199Other mailing lists are available for specific subsystems, such as
200USB, framebuffer devices, the VFS, the SCSI subsystem, etc. See the
201MAINTAINERS file for a mailing list that relates specifically to
202your change.
203
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800204Majordomo lists of VGER.KERNEL.ORG at:
205 <http://vger.kernel.org/vger-lists.html>
206
Paul Jackson1caf1f02005-07-31 22:34:48 -0700207If changes affect userland-kernel interfaces, please send
208the MAN-PAGES maintainer (as listed in the MAINTAINERS file)
209a man-pages patch, or at least a notification of the change,
210so that some information makes its way into the manual pages.
211
Michael Brunner8103b5c2009-08-04 00:41:11 +0200212Even if the maintainer did not respond in step #5, make sure to ALWAYS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213copy the maintainer when you change their code.
214
215For small patches you may want to CC the Trivial Patch Monkey
Markus Heidelberg82d27b22009-06-12 01:02:34 +0200216trivial@kernel.org which collects "trivial" patches. Have a look
217into the MAINTAINERS file for its current manager.
218Trivial patches must qualify for one of the following rules:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 Spelling fixes in documentation
Pavel Machek8e9cb8f2006-09-29 02:01:29 -0700220 Spelling fixes which could break grep(1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 Warning fixes (cluttering with useless warnings is bad)
222 Compilation fixes (only if they are actually correct)
223 Runtime fixes (only if they actually fix things)
Pavel Machek8e9cb8f2006-09-29 02:01:29 -0700224 Removing use of deprecated functions/macros (eg. check_region)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 Contact detail and documentation fixes
226 Non-portable code replaced by portable code (even in arch-specific,
227 since people copy, as long as it's trivial)
Pavel Machek8e9cb8f2006-09-29 02:01:29 -0700228 Any fix by the author/maintainer of the file (ie. patch monkey
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 in re-transmission mode)
Randy Dunlap84da7c02005-06-28 20:45:30 -0700230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
232
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002337) No MIME, no links, no compression, no attachments. Just plain text.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235Linus and other kernel developers need to be able to read and comment
236on the changes you are submitting. It is important for a kernel
237developer to be able to "quote" your changes, using standard e-mail
238tools, so that they may comment on specific portions of your code.
239
240For this reason, all patches should be submitting e-mail "inline".
241WARNING: Be wary of your editor's word-wrap corrupting your patch,
242if you choose to cut-n-paste your patch.
243
244Do not attach the patch as a MIME attachment, compressed or not.
245Many popular e-mail applications will not always transmit a MIME
246attachment as plain text, making it impossible to comment on your
247code. A MIME attachment also takes Linus a bit more time to process,
248decreasing the likelihood of your MIME-attached change being accepted.
249
250Exception: If your mailer is mangling patches then someone may ask
251you to re-send them using MIME.
252
Michael Opdenacker097091c2008-02-03 18:06:58 +0200253See Documentation/email-clients.txt for hints about configuring
254your e-mail client so that it sends your patches untouched.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002568) E-mail size.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700258When sending patches to Linus, always follow step #7.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
260Large changes are not appropriate for mailing lists, and some
Randy Dunlap4932be72009-10-01 15:44:06 -0700261maintainers. If your patch, uncompressed, exceeds 300 kB in size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262it is preferred that you store your patch on an Internet-accessible
263server, and provide instead a URL (link) pointing to your patch.
264
265
266
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002679) Name your kernel version.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269It is important to note, either in the subject line or in the patch
270description, the kernel version to which this patch applies.
271
272If the patch does not apply cleanly to the latest kernel version,
273Linus will not apply it.
274
275
276
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070027710) Don't get discouraged. Re-submit.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279After you have submitted your change, be patient and wait. If Linus
280likes your change and applies it, it will appear in the next version
281of the kernel that he releases.
282
283However, if your change doesn't appear in the next version of the
284kernel, there could be any number of reasons. It's YOUR job to
285narrow down those reasons, correct what was wrong, and submit your
286updated change.
287
288It is quite common for Linus to "drop" your patch without comment.
289That's the nature of the system. If he drops your patch, it could be
290due to
Pavel Machek8e9cb8f2006-09-29 02:01:29 -0700291* Your patch did not apply cleanly to the latest kernel version.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292* Your patch was not sufficiently discussed on linux-kernel.
Pavel Machek8e9cb8f2006-09-29 02:01:29 -0700293* A style issue (see section 2).
294* An e-mail formatting issue (re-read this section).
295* A technical problem with your change.
296* He gets tons of e-mail, and yours got lost in the shuffle.
297* You are being annoying.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
299When in doubt, solicit comments on linux-kernel mailing list.
300
301
302
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070030311) Include PATCH in the subject
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
305Due to high e-mail traffic to Linus, and to linux-kernel, it is common
306convention to prefix your subject line with [PATCH]. This lets Linus
307and other kernel developers more easily distinguish patches from other
308e-mail discussions.
309
310
311
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070031212) Sign your work
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314To improve tracking of who did what, especially with patches that can
315percolate to their final resting place in the kernel through several
316layers of maintainers, we've introduced a "sign-off" procedure on
317patches that are being emailed around.
318
319The sign-off is a simple line at the end of the explanation for the
320patch, which certifies that you wrote it or otherwise have the right to
Zac Storerdb12fb82011-08-13 12:34:45 -0700321pass it on as an open-source patch. The rules are pretty simple: if you
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322can certify the below:
323
Linus Torvaldscbd83da2005-06-13 17:51:55 -0700324 Developer's Certificate of Origin 1.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326 By making a contribution to this project, I certify that:
327
328 (a) The contribution was created in whole or in part by me and I
329 have the right to submit it under the open source license
330 indicated in the file; or
331
332 (b) The contribution is based upon previous work that, to the best
333 of my knowledge, is covered under an appropriate open source
334 license and I have the right under that license to submit that
335 work with modifications, whether created in whole or in part
336 by me, under the same open source license (unless I am
337 permitted to submit under a different license), as indicated
338 in the file; or
339
340 (c) The contribution was provided directly to me by some other
341 person who certified (a), (b) or (c) and I have not modified
342 it.
343
Linus Torvaldscbd83da2005-06-13 17:51:55 -0700344 (d) I understand and agree that this project and the contribution
345 are public and that a record of the contribution (including all
346 personal information I submit with it, including my sign-off) is
347 maintained indefinitely and may be redistributed consistent with
348 this project or the open source license(s) involved.
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350then you just add a line saying
351
Alexey Dobriyan9fd55592005-06-25 14:59:34 -0700352 Signed-off-by: Random J Developer <random@developer.example.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
Greg KHaf45f322006-09-12 20:35:52 -0700354using your real name (sorry, no pseudonyms or anonymous contributions.)
355
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356Some people also put extra tags at the end. They'll just be ignored for
357now, but you can do this to mark internal company procedures or just
358point out some special detail about the sign-off.
359
Willy Tarreauadbd5882008-06-03 00:20:28 +0200360If you are a subsystem or branch maintainer, sometimes you need to slightly
361modify patches you receive in order to merge them, because the code is not
362exactly the same in your tree and the submitters'. If you stick strictly to
363rule (c), you should ask the submitter to rediff, but this is a totally
364counter-productive waste of time and energy. Rule (b) allows you to adjust
365the code, but then it is very impolite to change one submitter's code and
366make him endorse your bugs. To solve this problem, it is recommended that
367you add a line between the last Signed-off-by header and yours, indicating
368the nature of your changes. While there is nothing mandatory about this, it
369seems like prepending the description with your mail and/or name, all
370enclosed in square brackets, is noticeable enough to make it obvious that
371you are responsible for last-minute changes. Example :
372
373 Signed-off-by: Random J Developer <random@developer.example.org>
374 [lucky@maintainer.example.org: struct foo moved from foo.c to foo.h]
375 Signed-off-by: Lucky K Maintainer <lucky@maintainer.example.org>
376
377This practise is particularly helpful if you maintain a stable branch and
378want at the same time to credit the author, track changes, merge the fix,
379and protect the submitter from complaints. Note that under no circumstances
380can you change the author's identity (the From header), as it is the one
381which appears in the changelog.
382
383Special note to back-porters: It seems to be a common and useful practise
384to insert an indication of the origin of a patch at the top of the commit
385message (just after the subject line) to facilitate tracking. For instance,
386here's what we see in 2.6-stable :
387
388 Date: Tue May 13 19:10:30 2008 +0000
389
390 SCSI: libiscsi regression in 2.6.25: fix nop timer handling
391
392 commit 4cf1043593db6a337f10e006c23c69e5fc93e722 upstream
393
394And here's what appears in 2.4 :
395
396 Date: Tue May 13 22:12:27 2008 +0200
397
398 wireless, airo: waitbusy() won't delay
399
400 [backport of 2.6 commit b7acbdfbd1f277c1eb23f344f899cfa4cd0bf36a]
401
402Whatever the format, this information provides a valuable help to people
403tracking your trees, and to people trying to trouble-shoot bugs in your
404tree.
405
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Jonathan Corbetef402032008-03-28 11:22:38 -060040713) When to use Acked-by: and Cc:
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700408
Andrew Morton0f44cd22007-06-08 13:46:45 -0700409The Signed-off-by: tag indicates that the signer was involved in the
410development of the patch, or that he/she was in the patch's delivery path.
411
412If a person was not directly involved in the preparation or handling of a
413patch but wishes to signify and record their approval of it then they can
414arrange to have an Acked-by: line added to the patch's changelog.
415
416Acked-by: is often used by the maintainer of the affected code when that
417maintainer neither contributed to nor forwarded the patch.
418
419Acked-by: is not as formal as Signed-off-by:. It is a record that the acker
420has at least reviewed the patch and has indicated acceptance. Hence patch
421mergers will sometimes manually convert an acker's "yep, looks good to me"
422into an Acked-by:.
423
424Acked-by: does not necessarily indicate acknowledgement of the entire patch.
425For example, if a patch affects multiple subsystems and has an Acked-by: from
426one subsystem maintainer then this usually indicates acknowledgement of just
427the part which affects that maintainer's code. Judgement should be used here.
Jonathan Corbetef402032008-03-28 11:22:38 -0600428When in doubt people should refer to the original discussion in the mailing
Andrew Morton0f44cd22007-06-08 13:46:45 -0700429list archives.
430
Jonathan Corbetef402032008-03-28 11:22:38 -0600431If a person has had the opportunity to comment on a patch, but has not
432provided such comments, you may optionally add a "Cc:" tag to the patch.
433This is the only tag which might be added without an explicit action by the
434person it names. This tag documents that potentially interested parties
435have been included in the discussion
Andrew Morton0f44cd22007-06-08 13:46:45 -0700436
Jonathan Corbetef402032008-03-28 11:22:38 -0600437
Mugunthan V N8543ae12013-04-29 16:18:17 -070043814) Using Reported-by:, Tested-by:, Reviewed-by: and Suggested-by:
Jonathan Corbetbbb0a4242009-01-16 09:49:50 -0700439
440If this patch fixes a problem reported by somebody else, consider adding a
441Reported-by: tag to credit the reporter for their contribution. Please
442note that this tag should not be added without the reporter's permission,
443especially if the problem was not reported in a public forum. That said,
444if we diligently credit our bug reporters, they will, hopefully, be
445inspired to help us again in the future.
Jonathan Corbetef402032008-03-28 11:22:38 -0600446
447A Tested-by: tag indicates that the patch has been successfully tested (in
448some environment) by the person named. This tag informs maintainers that
449some testing has been performed, provides a means to locate testers for
450future patches, and ensures credit for the testers.
451
452Reviewed-by:, instead, indicates that the patch has been reviewed and found
453acceptable according to the Reviewer's Statement:
454
455 Reviewer's statement of oversight
456
457 By offering my Reviewed-by: tag, I state that:
458
459 (a) I have carried out a technical review of this patch to
460 evaluate its appropriateness and readiness for inclusion into
461 the mainline kernel.
462
463 (b) Any problems, concerns, or questions relating to the patch
464 have been communicated back to the submitter. I am satisfied
465 with the submitter's response to my comments.
466
467 (c) While there may be things that could be improved with this
468 submission, I believe that it is, at this time, (1) a
469 worthwhile modification to the kernel, and (2) free of known
470 issues which would argue against its inclusion.
471
472 (d) While I have reviewed the patch and believe it to be sound, I
473 do not (unless explicitly stated elsewhere) make any
474 warranties or guarantees that it will achieve its stated
475 purpose or function properly in any given situation.
476
477A Reviewed-by tag is a statement of opinion that the patch is an
478appropriate modification of the kernel without any remaining serious
479technical issues. Any interested reviewer (who has done the work) can
480offer a Reviewed-by tag for a patch. This tag serves to give credit to
481reviewers and to inform maintainers of the degree of review which has been
482done on the patch. Reviewed-by: tags, when supplied by reviewers known to
483understand the subject area and to perform thorough reviews, will normally
Pavel Machek5801da12009-06-04 16:26:50 +0200484increase the likelihood of your patch getting into the kernel.
Jonathan Corbetef402032008-03-28 11:22:38 -0600485
Mugunthan V N8543ae12013-04-29 16:18:17 -0700486A Suggested-by: tag indicates that the patch idea is suggested by the person
487named and ensures credit to the person for the idea. Please note that this
488tag should not be added without the reporter's permission, especially if the
489idea was not posted in a public forum. That said, if we diligently credit our
490idea reporters, they will, hopefully, be inspired to help us again in the
491future.
492
Jonathan Corbetef402032008-03-28 11:22:38 -0600493
49415) The canonical patch format
Randy Dunlap84da7c02005-06-28 20:45:30 -0700495
Paul Jackson75f84262005-10-02 18:01:42 -0700496The canonical patch subject line is:
497
Paul Jacksond6b9acc2005-10-03 00:29:10 -0700498 Subject: [PATCH 001/123] subsystem: summary phrase
Paul Jackson75f84262005-10-02 18:01:42 -0700499
500The canonical patch message body contains the following:
501
502 - A "from" line specifying the patch author.
503
504 - An empty line.
505
506 - The body of the explanation, which will be copied to the
507 permanent changelog to describe this patch.
508
509 - The "Signed-off-by:" lines, described above, which will
510 also go in the changelog.
511
512 - A marker line containing simply "---".
513
514 - Any additional comments not suitable for the changelog.
515
516 - The actual patch (diff output).
517
518The Subject line format makes it very easy to sort the emails
519alphabetically by subject line - pretty much any email reader will
520support that - since because the sequence number is zero-padded,
521the numerical and alphabetic sort is the same.
522
Paul Jacksond6b9acc2005-10-03 00:29:10 -0700523The "subsystem" in the email's Subject should identify which
524area or subsystem of the kernel is being patched.
525
526The "summary phrase" in the email's Subject should concisely
527describe the patch which that email contains. The "summary
528phrase" should not be a filename. Do not use the same "summary
Randy Dunlap66effdc2007-05-09 02:33:42 -0700529phrase" for every patch in a whole patch series (where a "patch
530series" is an ordered sequence of multiple, related patches).
Paul Jacksond6b9acc2005-10-03 00:29:10 -0700531
Theodore Ts'o2ae19aca2009-04-16 07:44:45 -0400532Bear in mind that the "summary phrase" of your email becomes a
533globally-unique identifier for that patch. It propagates all the way
534into the git changelog. The "summary phrase" may later be used in
535developer discussions which refer to the patch. People will want to
536google for the "summary phrase" to read discussion regarding that
537patch. It will also be the only thing that people may quickly see
538when, two or three months later, they are going through perhaps
539thousands of patches using tools such as "gitk" or "git log
540--oneline".
541
542For these reasons, the "summary" must be no more than 70-75
543characters, and it must describe both what the patch changes, as well
544as why the patch might be necessary. It is challenging to be both
545succinct and descriptive, but that is what a well-written summary
546should do.
547
548The "summary phrase" may be prefixed by tags enclosed in square
549brackets: "Subject: [PATCH tag] <summary phrase>". The tags are not
550considered part of the summary phrase, but describe how the patch
551should be treated. Common tags might include a version descriptor if
552the multiple versions of the patch have been sent out in response to
553comments (i.e., "v1, v2, v3"), or "RFC" to indicate a request for
554comments. If there are four patches in a patch series the individual
555patches may be numbered like this: 1/4, 2/4, 3/4, 4/4. This assures
556that developers understand the order in which the patches should be
557applied and that they have reviewed or applied all of the patches in
558the patch series.
Paul Jacksond6b9acc2005-10-03 00:29:10 -0700559
560A couple of example Subjects:
561
562 Subject: [patch 2/5] ext2: improve scalability of bitmap searching
563 Subject: [PATCHv2 001/207] x86: fix eflags tracking
Paul Jackson75f84262005-10-02 18:01:42 -0700564
565The "from" line must be the very first line in the message body,
566and has the form:
567
568 From: Original Author <author@example.com>
569
570The "from" line specifies who will be credited as the author of the
571patch in the permanent changelog. If the "from" line is missing,
572then the "From:" line from the email header will be used to determine
573the patch author in the changelog.
574
575The explanation body will be committed to the permanent source
576changelog, so should make sense to a competent reader who has long
577since forgotten the immediate details of the discussion that might
Theodore Ts'o2ae19aca2009-04-16 07:44:45 -0400578have led to this patch. Including symptoms of the failure which the
579patch addresses (kernel log messages, oops messages, etc.) is
580especially useful for people who might be searching the commit logs
581looking for the applicable patch. If a patch fixes a compile failure,
582it may not be necessary to include _all_ of the compile failures; just
583enough that it is likely that someone searching for the patch can find
584it. As in the "summary phrase", it is important to be both succinct as
585well as descriptive.
Paul Jackson75f84262005-10-02 18:01:42 -0700586
587The "---" marker line serves the essential purpose of marking for patch
588handling tools where the changelog message ends.
589
590One good use for the additional comments after the "---" marker is for
Theodore Ts'o2ae19aca2009-04-16 07:44:45 -0400591a diffstat, to show what files have changed, and the number of
592inserted and deleted lines per file. A diffstat is especially useful
593on bigger patches. Other comments relevant only to the moment or the
594maintainer, not suitable for the permanent changelog, should also go
595here. A good example of such comments might be "patch changelogs"
596which describe what has changed between the v1 and v2 version of the
597patch.
598
599If you are going to include a diffstat after the "---" marker, please
600use diffstat options "-p 1 -w 70" so that filenames are listed from
601the top of the kernel source tree and don't use too much horizontal
602space (easily fit in 80 columns, maybe with some indentation).
Paul Jackson75f84262005-10-02 18:01:42 -0700603
604See more details on the proper patch format in the following
605references.
606
607
Randy Dunlap14863612008-07-27 20:44:24 -070060816) Sending "git pull" requests (from Linus emails)
Randy Dunlap84da7c02005-06-28 20:45:30 -0700609
Randy Dunlap14863612008-07-27 20:44:24 -0700610Please write the git repo address and branch name alone on the same line
611so that I can't even by mistake pull from the wrong branch, and so
612that a triple-click just selects the whole thing.
613
614So the proper format is something along the lines of:
615
616 "Please pull from
617
618 git://jdelvare.pck.nerim.net/jdelvare-2.6 i2c-for-linus
619
620 to get these changes:"
621
622so that I don't have to hunt-and-peck for the address and inevitably
623get it wrong (actually, I've only gotten it wrong a few times, and
624checking against the diffstat tells me when I get it wrong, but I'm
625just a lot more comfortable when I don't have to "look for" the right
626thing to pull, and double-check that I have the right branch-name).
627
628
629Please use "git diff -M --stat --summary" to generate the diffstat:
630the -M enables rename detection, and the summary enables a summary of
631new/deleted or renamed files.
632
633With rename detection, the statistics are rather different [...]
634because git will notice that a fair number of the changes are renames.
Randy Dunlap84da7c02005-06-28 20:45:30 -0700635
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636-----------------------------------
637SECTION 2 - HINTS, TIPS, AND TRICKS
638-----------------------------------
639
640This section lists many of the common "rules" associated with code
641submitted to the kernel. There are always exceptions... but you must
642have a really good reason for doing so. You could probably call this
643section Linus Computer Science 101.
644
645
646
6471) Read Documentation/CodingStyle
648
649Nuff said. If your code deviates too much from this, it is likely
650to be rejected without further review, and without comment.
651
Keiichi Kii5ab3bd52007-10-26 15:51:44 +0900652One significant exception is when moving code from one file to
653another -- in this case you should not modify the moved code at all in
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700654the same patch which moves it. This clearly delineates the act of
655moving the code and your changes. This greatly aids review of the
656actual differences and allows tools to better track the history of
657the code itself.
658
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700659Check your patches with the patch style checker prior to submission
Andy Whitcroftde7d4f02007-07-15 23:37:22 -0700660(scripts/checkpatch.pl). The style checker should be viewed as
661a guide not as the final word. If your code looks better with
662a violation then its probably best left alone.
663
664The checker reports at three levels:
665 - ERROR: things that are very likely to be wrong
666 - WARNING: things requiring careful review
667 - CHECK: things requiring thought
668
669You should be able to justify all violations that remain in your
670patch.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700671
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
673
6742) #ifdefs are ugly
675
676Code cluttered with ifdefs is difficult to read and maintain. Don't do
677it. Instead, put your ifdefs in a header, and conditionally define
678'static inline' functions, or macros, which are used in the code.
679Let the compiler optimize away the "no-op" case.
680
681Simple example, of poor code:
682
683 dev = alloc_etherdev (sizeof(struct funky_private));
684 if (!dev)
685 return -ENODEV;
686 #ifdef CONFIG_NET_FUNKINESS
687 init_funky_net(dev);
688 #endif
689
690Cleaned-up example:
691
692(in header)
693 #ifndef CONFIG_NET_FUNKINESS
694 static inline void init_funky_net (struct net_device *d) {}
695 #endif
696
697(in the code itself)
698 dev = alloc_etherdev (sizeof(struct funky_private));
699 if (!dev)
700 return -ENODEV;
701 init_funky_net(dev);
702
703
704
7053) 'static inline' is better than a macro
706
707Static inline functions are greatly preferred over macros.
708They provide type safety, have no length limitations, no formatting
709limitations, and under gcc they are as cheap as macros.
710
711Macros should only be used for cases where a static inline is clearly
Jim Meyeringf2b2ea62008-04-02 13:04:46 -0700712suboptimal [there are a few, isolated cases of this in fast paths],
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713or where it is impossible to use a static inline function [such as
714string-izing].
715
716'static inline' is preferred over 'static __inline__', 'extern inline',
717and 'extern __inline__'.
718
719
720
7214) Don't over-design.
722
723Don't try to anticipate nebulous future cases which may or may not
Randy Dunlap84da7c02005-06-28 20:45:30 -0700724be useful: "Make it as simple as you can, and no simpler."
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800726
727
728----------------------
729SECTION 3 - REFERENCES
730----------------------
731
732Andrew Morton, "The perfect patch" (tpp).
FD Cami2223c652008-10-15 22:02:00 -0700733 <http://userweb.kernel.org/~akpm/stuff/tpp.txt>
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800734
Pavel Machek8e9cb8f2006-09-29 02:01:29 -0700735Jeff Garzik, "Linux kernel patch submission format".
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800736 <http://linux.yyz.us/patch-format.html>
737
Pavel Machek8e9cb8f2006-09-29 02:01:29 -0700738Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer".
Vikram Narayananf5039932011-05-23 12:01:25 -0700739 <http://www.kroah.com/log/linux/maintainer.html>
740 <http://www.kroah.com/log/linux/maintainer-02.html>
741 <http://www.kroah.com/log/linux/maintainer-03.html>
742 <http://www.kroah.com/log/linux/maintainer-04.html>
743 <http://www.kroah.com/log/linux/maintainer-05.html>
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800744
Randy Dunlapbc7455f2006-07-30 03:03:45 -0700745NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people!
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800746 <http://marc.theaimsgroup.com/?l=linux-kernel&m=112112749912944&w=2>
747
Pavel Machek8e9cb8f2006-09-29 02:01:29 -0700748Kernel Documentation/CodingStyle:
Qi Yong4db29c12007-06-12 13:06:49 +0800749 <http://users.sosdg.org/~qiyong/lxr/source/Documentation/CodingStyle>
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800750
Pavel Machek8e9cb8f2006-09-29 02:01:29 -0700751Linus Torvalds's mail on the canonical patch format:
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800752 <http://lkml.org/lkml/2005/4/7/183>
Andi Kleen95367272008-10-15 22:02:02 -0700753
754Andi Kleen, "On submitting kernel patches"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300755 Some strategies to get difficult or controversial changes in.
Andi Kleen95367272008-10-15 22:02:02 -0700756 http://halobates.de/on-submitting-patches.pdf
757
Xose Vazquez Perez5b0ed2c2006-01-08 01:02:49 -0800758--