[PATCH] docs: updated some code docs
[linux-2.6.git] / Documentation / SubmittingPatches
1
2         How to Get Your Change Into the Linux Kernel
3                 or
4         Care And Operation Of Your Linus Torvalds
5
6
7
8 For a person or company who wishes to submit a change to the Linux
9 kernel, the process can sometimes be daunting if you're not familiar
10 with "the system."  This text is a collection of suggestions which
11 can greatly increase the chances of your change being accepted.
12
13 If you are submitting a driver, also read Documentation/SubmittingDrivers.
14
15
16
17 --------------------------------------------
18 SECTION 1 - CREATING AND SENDING YOUR CHANGE
19 --------------------------------------------
20
21
22
23 1) "diff -up"
24 ------------
25
26 Use "diff -up" or "diff -uprN" to create patches.
27
28 All changes to the Linux kernel occur in the form of patches, as
29 generated by diff(1).  When creating your patch, make sure to create it
30 in "unified diff" format, as supplied by the '-u' argument to diff(1).
31 Also, please use the '-p' argument which shows which C function each
32 change is in - that makes the resultant diff a lot easier to read.
33 Patches should be based in the root kernel source directory,
34 not in any lower subdirectory.
35
36 To create a patch for a single file, it is often sufficient to do:
37
38         SRCTREE= linux-2.6
39         MYFILE=  drivers/net/mydriver.c
40
41         cd $SRCTREE
42         cp $MYFILE $MYFILE.orig
43         vi $MYFILE      # make your change
44         cd ..
45         diff -up $SRCTREE/$MYFILE{.orig,} > /tmp/patch
46
47 To create a patch for multiple files, you should unpack a "vanilla",
48 or unmodified kernel source tree, and generate a diff against your
49 own source tree.  For example:
50
51         MYSRC= /devel/linux-2.6
52
53         tar xvfz linux-2.6.12.tar.gz
54         mv linux-2.6.12 linux-2.6.12-vanilla
55         diff -uprN -X linux-2.6.12-vanilla/Documentation/dontdiff \
56                 linux-2.6.12-vanilla $MYSRC > /tmp/patch
57
58 "dontdiff" is a list of files which are generated by the kernel during
59 the build process, and should be ignored in any diff(1)-generated
60 patch.  The "dontdiff" file is included in the kernel tree in
61 2.6.12 and later.  For earlier kernel versions, you can get it
62 from <http://www.xenotime.net/linux/doc/dontdiff>.
63
64 Make sure your patch does not include any extra files which do not
65 belong in a patch submission.  Make sure to review your patch -after-
66 generated it with diff(1), to ensure accuracy.
67
68 If your changes produce a lot of deltas, you may want to look into
69 splitting them into individual patches which modify things in
70 logical stages.  This will facilitate easier reviewing by other
71 kernel developers, very important if you want your patch accepted.
72 There are a number of scripts which can aid in this:
73
74 Quilt:
75 http://savannah.nongnu.org/projects/quilt
76
77 Randy Dunlap's patch scripts:
78 http://www.xenotime.net/linux/scripts/patching-scripts-002.tar.gz
79
80 Andrew Morton's patch scripts:
81 http://www.zip.com.au/~akpm/linux/patches/
82 Instead of these scripts, quilt is the recommended patch management
83 tool (see above).
84
85
86
87 2) Describe your changes.
88
89 Describe the technical detail of the change(s) your patch includes.
90
91 Be as specific as possible.  The WORST descriptions possible include
92 things like "update driver X", "bug fix for driver X", or "this patch
93 includes updates for subsystem X.  Please apply."
94
95 If your description starts to get long, that's a sign that you probably
96 need to split up your patch.  See #3, next.
97
98
99
100 3) Separate your changes.
101
102 Separate _logical changes_ into a single patch file.
103
104 For example, if your changes include both bug fixes and performance
105 enhancements for a single driver, separate those changes into two
106 or more patches.  If your changes include an API update, and a new
107 driver which uses that new API, separate those into two patches.
108
109 On the other hand, if you make a single change to numerous files,
110 group those changes into a single patch.  Thus a single logical change
111 is contained within a single patch.
112
113 If one patch depends on another patch in order for a change to be
114 complete, that is OK.  Simply note "this patch depends on patch X"
115 in your patch description.
116
117 If you cannot condense your patch set into a smaller set of patches,
118 then only post say 15 or so at a time and wait for review and integration.
119
120
121
122 4) Select e-mail destination.
123
124 Look through the MAINTAINERS file and the source code, and determine
125 if your change applies to a specific subsystem of the kernel, with
126 an assigned maintainer.  If so, e-mail that person.
127
128 If no maintainer is listed, or the maintainer does not respond, send
129 your patch to the primary Linux kernel developer's mailing list,
130 linux-kernel@vger.kernel.org.  Most kernel developers monitor this
131 e-mail list, and can comment on your changes.
132
133
134 Do not send more than 15 patches at once to the vger mailing lists!!!
135
136
137 Linus Torvalds is the final arbiter of all changes accepted into the
138 Linux kernel.  His e-mail address is <torvalds@osdl.org>.  He gets
139 a lot of e-mail, so typically you should do your best to -avoid- sending
140 him e-mail.
141
142 Patches which are bug fixes, are "obvious" changes, or similarly
143 require little discussion should be sent or CC'd to Linus.  Patches
144 which require discussion or do not have a clear advantage should
145 usually be sent first to linux-kernel.  Only after the patch is
146 discussed should the patch then be submitted to Linus.
147
148
149
150 5) Select your CC (e-mail carbon copy) list.
151
152 Unless you have a reason NOT to do so, CC linux-kernel@vger.kernel.org.
153
154 Other kernel developers besides Linus need to be aware of your change,
155 so that they may comment on it and offer code review and suggestions.
156 linux-kernel is the primary Linux kernel developer mailing list.
157 Other mailing lists are available for specific subsystems, such as
158 USB, framebuffer devices, the VFS, the SCSI subsystem, etc.  See the
159 MAINTAINERS file for a mailing list that relates specifically to
160 your change.
161
162 Majordomo lists of VGER.KERNEL.ORG at:
163         <http://vger.kernel.org/vger-lists.html>
164
165 If changes affect userland-kernel interfaces, please send
166 the MAN-PAGES maintainer (as listed in the MAINTAINERS file)
167 a man-pages patch, or at least a notification of the change,
168 so that some information makes its way into the manual pages.
169
170 Even if the maintainer did not respond in step #4, make sure to ALWAYS
171 copy the maintainer when you change their code.
172
173 For small patches you may want to CC the Trivial Patch Monkey
174 trivial@kernel.org managed by Adrian Bunk; which collects "trivial"
175 patches. Trivial patches must qualify for one of the following rules:
176  Spelling fixes in documentation
177  Spelling fixes which could break grep(1).
178  Warning fixes (cluttering with useless warnings is bad)
179  Compilation fixes (only if they are actually correct)
180  Runtime fixes (only if they actually fix things)
181  Removing use of deprecated functions/macros (eg. check_region).
182  Contact detail and documentation fixes
183  Non-portable code replaced by portable code (even in arch-specific,
184  since people copy, as long as it's trivial)
185  Any fix by the author/maintainer of the file. (ie. patch monkey
186  in re-transmission mode)
187 URL: <http://www.kernel.org/pub/linux/kernel/people/bunk/trivial/>
188
189
190
191
192 6) No MIME, no links, no compression, no attachments.  Just plain text.
193
194 Linus and other kernel developers need to be able to read and comment
195 on the changes you are submitting.  It is important for a kernel
196 developer to be able to "quote" your changes, using standard e-mail
197 tools, so that they may comment on specific portions of your code.
198
199 For this reason, all patches should be submitting e-mail "inline".
200 WARNING:  Be wary of your editor's word-wrap corrupting your patch,
201 if you choose to cut-n-paste your patch.
202
203 Do not attach the patch as a MIME attachment, compressed or not.
204 Many popular e-mail applications will not always transmit a MIME
205 attachment as plain text, making it impossible to comment on your
206 code.  A MIME attachment also takes Linus a bit more time to process,
207 decreasing the likelihood of your MIME-attached change being accepted.
208
209 Exception:  If your mailer is mangling patches then someone may ask
210 you to re-send them using MIME.
211
212
213
214 7) E-mail size.
215
216 When sending patches to Linus, always follow step #6.
217
218 Large changes are not appropriate for mailing lists, and some
219 maintainers.  If your patch, uncompressed, exceeds 40 kB in size,
220 it is preferred that you store your patch on an Internet-accessible
221 server, and provide instead a URL (link) pointing to your patch.
222
223
224
225 8) Name your kernel version.
226
227 It is important to note, either in the subject line or in the patch
228 description, the kernel version to which this patch applies.
229
230 If the patch does not apply cleanly to the latest kernel version,
231 Linus will not apply it.
232
233
234
235 9) Don't get discouraged.  Re-submit.
236
237 After you have submitted your change, be patient and wait.  If Linus
238 likes your change and applies it, it will appear in the next version
239 of the kernel that he releases.
240
241 However, if your change doesn't appear in the next version of the
242 kernel, there could be any number of reasons.  It's YOUR job to
243 narrow down those reasons, correct what was wrong, and submit your
244 updated change.
245
246 It is quite common for Linus to "drop" your patch without comment.
247 That's the nature of the system.  If he drops your patch, it could be
248 due to
249 * Your patch did not apply cleanly to the latest kernel version
250 * Your patch was not sufficiently discussed on linux-kernel.
251 * A style issue (see section 2),
252 * An e-mail formatting issue (re-read this section)
253 * A technical problem with your change
254 * He gets tons of e-mail, and yours got lost in the shuffle
255 * You are being annoying (See Figure 1)
256
257 When in doubt, solicit comments on linux-kernel mailing list.
258
259
260
261 10) Include PATCH in the subject
262
263 Due to high e-mail traffic to Linus, and to linux-kernel, it is common
264 convention to prefix your subject line with [PATCH].  This lets Linus
265 and other kernel developers more easily distinguish patches from other
266 e-mail discussions.
267
268
269
270 11) Sign your work
271
272 To improve tracking of who did what, especially with patches that can
273 percolate to their final resting place in the kernel through several
274 layers of maintainers, we've introduced a "sign-off" procedure on
275 patches that are being emailed around.
276
277 The sign-off is a simple line at the end of the explanation for the
278 patch, which certifies that you wrote it or otherwise have the right to
279 pass it on as a open-source patch.  The rules are pretty simple: if you
280 can certify the below:
281
282         Developer's Certificate of Origin 1.1
283
284         By making a contribution to this project, I certify that:
285
286         (a) The contribution was created in whole or in part by me and I
287             have the right to submit it under the open source license
288             indicated in the file; or
289
290         (b) The contribution is based upon previous work that, to the best
291             of my knowledge, is covered under an appropriate open source
292             license and I have the right under that license to submit that
293             work with modifications, whether created in whole or in part
294             by me, under the same open source license (unless I am
295             permitted to submit under a different license), as indicated
296             in the file; or
297
298         (c) The contribution was provided directly to me by some other
299             person who certified (a), (b) or (c) and I have not modified
300             it.
301
302         (d) I understand and agree that this project and the contribution
303             are public and that a record of the contribution (including all
304             personal information I submit with it, including my sign-off) is
305             maintained indefinitely and may be redistributed consistent with
306             this project or the open source license(s) involved.
307
308 then you just add a line saying
309
310         Signed-off-by: Random J Developer <random@developer.example.org>
311
312 Some people also put extra tags at the end.  They'll just be ignored for
313 now, but you can do this to mark internal company procedures or just
314 point out some special detail about the sign-off. 
315
316
317 12) The canonical patch format
318
319 The canonical patch subject line is:
320
321     Subject: [PATCH 001/123] subsystem: summary phrase
322
323 The canonical patch message body contains the following:
324
325   - A "from" line specifying the patch author.
326
327   - An empty line.
328
329   - The body of the explanation, which will be copied to the
330     permanent changelog to describe this patch.
331
332   - The "Signed-off-by:" lines, described above, which will
333     also go in the changelog.
334
335   - A marker line containing simply "---".
336
337   - Any additional comments not suitable for the changelog.
338
339   - The actual patch (diff output).
340
341 The Subject line format makes it very easy to sort the emails
342 alphabetically by subject line - pretty much any email reader will
343 support that - since because the sequence number is zero-padded,
344 the numerical and alphabetic sort is the same.
345
346 The "subsystem" in the email's Subject should identify which
347 area or subsystem of the kernel is being patched.
348
349 The "summary phrase" in the email's Subject should concisely
350 describe the patch which that email contains.  The "summary
351 phrase" should not be a filename.  Do not use the same "summary
352 phrase" for every patch in a whole patch series.
353
354 Bear in mind that the "summary phrase" of your email becomes
355 a globally-unique identifier for that patch.  It propagates
356 all the way into the git changelog.  The "summary phrase" may
357 later be used in developer discussions which refer to the patch.
358 People will want to google for the "summary phrase" to read
359 discussion regarding that patch.
360
361 A couple of example Subjects:
362
363     Subject: [patch 2/5] ext2: improve scalability of bitmap searching
364     Subject: [PATCHv2 001/207] x86: fix eflags tracking
365
366 The "from" line must be the very first line in the message body,
367 and has the form:
368
369         From: Original Author <author@example.com>
370
371 The "from" line specifies who will be credited as the author of the
372 patch in the permanent changelog.  If the "from" line is missing,
373 then the "From:" line from the email header will be used to determine
374 the patch author in the changelog.
375
376 The explanation body will be committed to the permanent source
377 changelog, so should make sense to a competent reader who has long
378 since forgotten the immediate details of the discussion that might
379 have led to this patch.
380
381 The "---" marker line serves the essential purpose of marking for patch
382 handling tools where the changelog message ends.
383
384 One good use for the additional comments after the "---" marker is for
385 a diffstat, to show what files have changed, and the number of inserted
386 and deleted lines per file.  A diffstat is especially useful on bigger
387 patches.  Other comments relevant only to the moment or the maintainer,
388 not suitable for the permanent changelog, should also go here.
389
390 See more details on the proper patch format in the following
391 references.
392
393
394
395
396 -----------------------------------
397 SECTION 2 - HINTS, TIPS, AND TRICKS
398 -----------------------------------
399
400 This section lists many of the common "rules" associated with code
401 submitted to the kernel.  There are always exceptions... but you must
402 have a really good reason for doing so.  You could probably call this
403 section Linus Computer Science 101.
404
405
406
407 1) Read Documentation/CodingStyle
408
409 Nuff said.  If your code deviates too much from this, it is likely
410 to be rejected without further review, and without comment.
411
412
413
414 2) #ifdefs are ugly
415
416 Code cluttered with ifdefs is difficult to read and maintain.  Don't do
417 it.  Instead, put your ifdefs in a header, and conditionally define
418 'static inline' functions, or macros, which are used in the code.
419 Let the compiler optimize away the "no-op" case.
420
421 Simple example, of poor code:
422
423         dev = alloc_etherdev (sizeof(struct funky_private));
424         if (!dev)
425                 return -ENODEV;
426         #ifdef CONFIG_NET_FUNKINESS
427         init_funky_net(dev);
428         #endif
429
430 Cleaned-up example:
431
432 (in header)
433         #ifndef CONFIG_NET_FUNKINESS
434         static inline void init_funky_net (struct net_device *d) {}
435         #endif
436
437 (in the code itself)
438         dev = alloc_etherdev (sizeof(struct funky_private));
439         if (!dev)
440                 return -ENODEV;
441         init_funky_net(dev);
442
443
444
445 3) 'static inline' is better than a macro
446
447 Static inline functions are greatly preferred over macros.
448 They provide type safety, have no length limitations, no formatting
449 limitations, and under gcc they are as cheap as macros.
450
451 Macros should only be used for cases where a static inline is clearly
452 suboptimal [there a few, isolated cases of this in fast paths],
453 or where it is impossible to use a static inline function [such as
454 string-izing].
455
456 'static inline' is preferred over 'static __inline__', 'extern inline',
457 and 'extern __inline__'.
458
459
460
461 4) Don't over-design.
462
463 Don't try to anticipate nebulous future cases which may or may not
464 be useful:  "Make it as simple as you can, and no simpler."
465
466
467
468 ----------------------
469 SECTION 3 - REFERENCES
470 ----------------------
471
472 Andrew Morton, "The perfect patch" (tpp).
473   <http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt>
474
475 Jeff Garzik, "Linux kernel patch submission format."
476   <http://linux.yyz.us/patch-format.html>
477
478 Greg Kroah, "How to piss off a kernel subsystem maintainer".
479   <http://www.kroah.com/log/2005/03/31/>
480   <http://www.kroah.com/log/2005/07/08/>
481   <http://www.kroah.com/log/2005/10/19/>
482
483 NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people!.
484   <http://marc.theaimsgroup.com/?l=linux-kernel&m=112112749912944&w=2>
485
486 Kernel Documentation/CodingStyle
487   <http://sosdg.org/~coywolf/lxr/source/Documentation/CodingStyle>
488
489 Linus Torvald's mail on the canonical patch format:
490   <http://lkml.org/lkml/2005/4/7/183>
491 --
492 Last updated on 17 Nov 2005.