SubmittingPatches: add style recommendation to use imperative descriptions
[sfrench/cifs-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 Read Documentation/SubmitChecklist for a list of items to check
14 before submitting code.  If you are submitting a driver, also read
15 Documentation/SubmittingDrivers.
16
17
18
19 --------------------------------------------
20 SECTION 1 - CREATING AND SENDING YOUR CHANGE
21 --------------------------------------------
22
23
24
25 1) "diff -up"
26 ------------
27
28 Use "diff -up" or "diff -uprN" to create patches.
29
30 All changes to the Linux kernel occur in the form of patches, as
31 generated by diff(1).  When creating your patch, make sure to create it
32 in "unified diff" format, as supplied by the '-u' argument to diff(1).
33 Also, please use the '-p' argument which shows which C function each
34 change is in - that makes the resultant diff a lot easier to read.
35 Patches should be based in the root kernel source directory,
36 not in any lower subdirectory.
37
38 To create a patch for a single file, it is often sufficient to do:
39
40         SRCTREE= linux-2.6
41         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
49 To create a patch for multiple files, you should unpack a "vanilla",
50 or unmodified kernel source tree, and generate a diff against your
51 own source tree.  For example:
52
53         MYSRC= /devel/linux-2.6
54
55         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
59
60 "dontdiff" is a list of files which are generated by the kernel during
61 the build process, and should be ignored in any diff(1)-generated
62 patch.  The "dontdiff" file is included in the kernel tree in
63 2.6.12 and later.
64
65 Make sure your patch does not include any extra files which do not
66 belong in a patch submission.  Make sure to review your patch -after-
67 generated it with diff(1), to ensure accuracy.
68
69 If your changes produce a lot of deltas, you may want to look into
70 splitting them into individual patches which modify things in
71 logical stages.  This will facilitate easier reviewing by other
72 kernel developers, very important if you want your patch accepted.
73 There are a number of scripts which can aid in this:
74
75 Quilt:
76 http://savannah.nongnu.org/projects/quilt
77
78 Andrew Morton's patch scripts:
79 http://userweb.kernel.org/~akpm/stuff/patch-scripts.tar.gz
80 Instead of these scripts, quilt is the recommended patch management
81 tool (see above).
82
83
84
85 2) Describe your changes.
86
87 Describe the technical detail of the change(s) your patch includes.
88
89 Be as specific as possible.  The WORST descriptions possible include
90 things like "update driver X", "bug fix for driver X", or "this patch
91 includes updates for subsystem X.  Please apply."
92
93 The maintainer will thank you if you write your patch description in a
94 form which can be easily pulled into Linux's source code management
95 system, git, as a "commit log".  See #15, below.
96
97 If your description starts to get long, that's a sign that you probably
98 need to split up your patch.  See #3, next.
99
100 When you submit or resubmit a patch or patch series, include the
101 complete patch description and justification for it.  Don't just
102 say that this is version N of the patch (series).  Don't expect the
103 patch merger to refer back to earlier patch versions or referenced
104 URLs to find the patch description and put that into the patch.
105 I.e., the patch (series) and its description should be self-contained.
106 This benefits both the patch merger(s) and reviewers.  Some reviewers
107 probably didn't even receive earlier versions of the patch.
108
109 Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
110 instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
111 to do frotz", as if you are giving orders to the codebase to change
112 its behaviour.
113
114 If the patch fixes a logged bug entry, refer to that bug entry by
115 number and URL.
116
117 If you want to refer to a specific commit, don't just refer to the
118 SHA-1 ID of the commit. Please also include the oneline summary of
119 the commit, to make it easier for reviewers to know what it is about.
120 Example:
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
127
128 3) Separate your changes.
129
130 Separate _logical changes_ into a single patch file.
131
132 For example, if your changes include both bug fixes and performance
133 enhancements for a single driver, separate those changes into two
134 or more patches.  If your changes include an API update, and a new
135 driver which uses that new API, separate those into two patches.
136
137 On the other hand, if you make a single change to numerous files,
138 group those changes into a single patch.  Thus a single logical change
139 is contained within a single patch.
140
141 If one patch depends on another patch in order for a change to be
142 complete, that is OK.  Simply note "this patch depends on patch X"
143 in your patch description.
144
145 If you cannot condense your patch set into a smaller set of patches,
146 then only post say 15 or so at a time and wait for review and integration.
147
148
149
150 4) Style check your changes.
151
152 Check your patch for basic style violations, details of which can be
153 found in Documentation/CodingStyle.  Failure to do so simply wastes
154 the reviewers time and will get your patch rejected, probably
155 without even being read.
156
157 At a minimum you should check your patches with the patch style
158 checker prior to submission (scripts/checkpatch.pl).  You should
159 be able to justify all violations that remain in your patch.
160
161
162
163 5) Select e-mail destination.
164
165 Look through the MAINTAINERS file and the source code, and determine
166 if your change applies to a specific subsystem of the kernel, with
167 an assigned maintainer.  If so, e-mail that person.  The script
168 scripts/get_maintainer.pl can be very useful at this step.
169
170 If no maintainer is listed, or the maintainer does not respond, send
171 your patch to the primary Linux kernel developer's mailing list,
172 linux-kernel@vger.kernel.org.  Most kernel developers monitor this
173 e-mail list, and can comment on your changes.
174
175
176 Do not send more than 15 patches at once to the vger mailing lists!!!
177
178
179 Linus Torvalds is the final arbiter of all changes accepted into the
180 Linux kernel.  His e-mail address is <torvalds@linux-foundation.org>. 
181 He gets a lot of e-mail, so typically you should do your best to -avoid-
182 sending him e-mail. 
183
184 Patches which are bug fixes, are "obvious" changes, or similarly
185 require little discussion should be sent or CC'd to Linus.  Patches
186 which require discussion or do not have a clear advantage should
187 usually be sent first to linux-kernel.  Only after the patch is
188 discussed should the patch then be submitted to Linus.
189
190
191
192 6) Select your CC (e-mail carbon copy) list.
193
194 Unless you have a reason NOT to do so, CC linux-kernel@vger.kernel.org.
195
196 Other kernel developers besides Linus need to be aware of your change,
197 so that they may comment on it and offer code review and suggestions.
198 linux-kernel is the primary Linux kernel developer mailing list.
199 Other mailing lists are available for specific subsystems, such as
200 USB, framebuffer devices, the VFS, the SCSI subsystem, etc.  See the
201 MAINTAINERS file for a mailing list that relates specifically to
202 your change.
203
204 Majordomo lists of VGER.KERNEL.ORG at:
205         <http://vger.kernel.org/vger-lists.html>
206
207 If changes affect userland-kernel interfaces, please send
208 the MAN-PAGES maintainer (as listed in the MAINTAINERS file)
209 a man-pages patch, or at least a notification of the change,
210 so that some information makes its way into the manual pages.
211
212 Even if the maintainer did not respond in step #5, make sure to ALWAYS
213 copy the maintainer when you change their code.
214
215 For small patches you may want to CC the Trivial Patch Monkey
216 trivial@kernel.org which collects "trivial" patches. Have a look
217 into the MAINTAINERS file for its current manager.
218 Trivial patches must qualify for one of the following rules:
219  Spelling fixes in documentation
220  Spelling fixes which could break grep(1)
221  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)
224  Removing use of deprecated functions/macros (eg. check_region)
225  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)
228  Any fix by the author/maintainer of the file (ie. patch monkey
229  in re-transmission mode)
230
231
232
233 7) No MIME, no links, no compression, no attachments.  Just plain text.
234
235 Linus and other kernel developers need to be able to read and comment
236 on the changes you are submitting.  It is important for a kernel
237 developer to be able to "quote" your changes, using standard e-mail
238 tools, so that they may comment on specific portions of your code.
239
240 For this reason, all patches should be submitting e-mail "inline".
241 WARNING:  Be wary of your editor's word-wrap corrupting your patch,
242 if you choose to cut-n-paste your patch.
243
244 Do not attach the patch as a MIME attachment, compressed or not.
245 Many popular e-mail applications will not always transmit a MIME
246 attachment as plain text, making it impossible to comment on your
247 code.  A MIME attachment also takes Linus a bit more time to process,
248 decreasing the likelihood of your MIME-attached change being accepted.
249
250 Exception:  If your mailer is mangling patches then someone may ask
251 you to re-send them using MIME.
252
253 See Documentation/email-clients.txt for hints about configuring
254 your e-mail client so that it sends your patches untouched.
255
256 8) E-mail size.
257
258 When sending patches to Linus, always follow step #7.
259
260 Large changes are not appropriate for mailing lists, and some
261 maintainers.  If your patch, uncompressed, exceeds 300 kB in size,
262 it is preferred that you store your patch on an Internet-accessible
263 server, and provide instead a URL (link) pointing to your patch.
264
265
266
267 9) Name your kernel version.
268
269 It is important to note, either in the subject line or in the patch
270 description, the kernel version to which this patch applies.
271
272 If the patch does not apply cleanly to the latest kernel version,
273 Linus will not apply it.
274
275
276
277 10) Don't get discouraged.  Re-submit.
278
279 After you have submitted your change, be patient and wait.  If Linus
280 likes your change and applies it, it will appear in the next version
281 of the kernel that he releases.
282
283 However, if your change doesn't appear in the next version of the
284 kernel, there could be any number of reasons.  It's YOUR job to
285 narrow down those reasons, correct what was wrong, and submit your
286 updated change.
287
288 It is quite common for Linus to "drop" your patch without comment.
289 That's the nature of the system.  If he drops your patch, it could be
290 due to
291 * Your patch did not apply cleanly to the latest kernel version.
292 * Your patch was not sufficiently discussed on linux-kernel.
293 * 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.
298
299 When in doubt, solicit comments on linux-kernel mailing list.
300
301
302
303 11) Include PATCH in the subject
304
305 Due to high e-mail traffic to Linus, and to linux-kernel, it is common
306 convention to prefix your subject line with [PATCH].  This lets Linus
307 and other kernel developers more easily distinguish patches from other
308 e-mail discussions.
309
310
311
312 12) Sign your work
313
314 To improve tracking of who did what, especially with patches that can
315 percolate to their final resting place in the kernel through several
316 layers of maintainers, we've introduced a "sign-off" procedure on
317 patches that are being emailed around.
318
319 The sign-off is a simple line at the end of the explanation for the
320 patch, which certifies that you wrote it or otherwise have the right to
321 pass it on as an open-source patch.  The rules are pretty simple: if you
322 can certify the below:
323
324         Developer's Certificate of Origin 1.1
325
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
344         (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
350 then you just add a line saying
351
352         Signed-off-by: Random J Developer <random@developer.example.org>
353
354 using your real name (sorry, no pseudonyms or anonymous contributions.)
355
356 Some people also put extra tags at the end.  They'll just be ignored for
357 now, but you can do this to mark internal company procedures or just
358 point out some special detail about the sign-off. 
359
360 If you are a subsystem or branch maintainer, sometimes you need to slightly
361 modify patches you receive in order to merge them, because the code is not
362 exactly the same in your tree and the submitters'. If you stick strictly to
363 rule (c), you should ask the submitter to rediff, but this is a totally
364 counter-productive waste of time and energy. Rule (b) allows you to adjust
365 the code, but then it is very impolite to change one submitter's code and
366 make him endorse your bugs. To solve this problem, it is recommended that
367 you add a line between the last Signed-off-by header and yours, indicating
368 the nature of your changes. While there is nothing mandatory about this, it
369 seems like prepending the description with your mail and/or name, all
370 enclosed in square brackets, is noticeable enough to make it obvious that
371 you 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
377 This practise is particularly helpful if you maintain a stable branch and
378 want at the same time to credit the author, track changes, merge the fix,
379 and protect the submitter from complaints. Note that under no circumstances
380 can you change the author's identity (the From header), as it is the one
381 which appears in the changelog.
382
383 Special note to back-porters: It seems to be a common and useful practise
384 to insert an indication of the origin of a patch at the top of the commit
385 message (just after the subject line) to facilitate tracking. For instance,
386 here'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
394 And 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
402 Whatever the format, this information provides a valuable help to people
403 tracking your trees, and to people trying to trouble-shoot bugs in your
404 tree.
405
406
407 13) When to use Acked-by: and Cc:
408
409 The Signed-off-by: tag indicates that the signer was involved in the
410 development of the patch, or that he/she was in the patch's delivery path.
411
412 If a person was not directly involved in the preparation or handling of a
413 patch but wishes to signify and record their approval of it then they can
414 arrange to have an Acked-by: line added to the patch's changelog.
415
416 Acked-by: is often used by the maintainer of the affected code when that
417 maintainer neither contributed to nor forwarded the patch.
418
419 Acked-by: is not as formal as Signed-off-by:.  It is a record that the acker
420 has at least reviewed the patch and has indicated acceptance.  Hence patch
421 mergers will sometimes manually convert an acker's "yep, looks good to me"
422 into an Acked-by:.
423
424 Acked-by: does not necessarily indicate acknowledgement of the entire patch.
425 For example, if a patch affects multiple subsystems and has an Acked-by: from
426 one subsystem maintainer then this usually indicates acknowledgement of just
427 the part which affects that maintainer's code.  Judgement should be used here.
428 When in doubt people should refer to the original discussion in the mailing
429 list archives.
430
431 If a person has had the opportunity to comment on a patch, but has not
432 provided such comments, you may optionally add a "Cc:" tag to the patch.
433 This is the only tag which might be added without an explicit action by the
434 person it names.  This tag documents that potentially interested parties
435 have been included in the discussion
436
437
438 14) Using Reported-by:, Tested-by:, Reviewed-by: and Suggested-by:
439
440 If this patch fixes a problem reported by somebody else, consider adding a
441 Reported-by: tag to credit the reporter for their contribution.  Please
442 note that this tag should not be added without the reporter's permission,
443 especially if the problem was not reported in a public forum.  That said,
444 if we diligently credit our bug reporters, they will, hopefully, be
445 inspired to help us again in the future.
446
447 A Tested-by: tag indicates that the patch has been successfully tested (in
448 some environment) by the person named.  This tag informs maintainers that
449 some testing has been performed, provides a means to locate testers for
450 future patches, and ensures credit for the testers.
451
452 Reviewed-by:, instead, indicates that the patch has been reviewed and found
453 acceptable 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
477 A Reviewed-by tag is a statement of opinion that the patch is an
478 appropriate modification of the kernel without any remaining serious
479 technical issues.  Any interested reviewer (who has done the work) can
480 offer a Reviewed-by tag for a patch.  This tag serves to give credit to
481 reviewers and to inform maintainers of the degree of review which has been
482 done on the patch.  Reviewed-by: tags, when supplied by reviewers known to
483 understand the subject area and to perform thorough reviews, will normally
484 increase the likelihood of your patch getting into the kernel.
485
486 A Suggested-by: tag indicates that the patch idea is suggested by the person
487 named and ensures credit to the person for the idea. Please note that this
488 tag should not be added without the reporter's permission, especially if the
489 idea was not posted in a public forum. That said, if we diligently credit our
490 idea reporters, they will, hopefully, be inspired to help us again in the
491 future.
492
493
494 15) The canonical patch format
495
496 The canonical patch subject line is:
497
498     Subject: [PATCH 001/123] subsystem: summary phrase
499
500 The 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
518 The Subject line format makes it very easy to sort the emails
519 alphabetically by subject line - pretty much any email reader will
520 support that - since because the sequence number is zero-padded,
521 the numerical and alphabetic sort is the same.
522
523 The "subsystem" in the email's Subject should identify which
524 area or subsystem of the kernel is being patched.
525
526 The "summary phrase" in the email's Subject should concisely
527 describe the patch which that email contains.  The "summary
528 phrase" should not be a filename.  Do not use the same "summary
529 phrase" for every patch in a whole patch series (where a "patch
530 series" is an ordered sequence of multiple, related patches).
531
532 Bear in mind that the "summary phrase" of your email becomes a
533 globally-unique identifier for that patch.  It propagates all the way
534 into the git changelog.  The "summary phrase" may later be used in
535 developer discussions which refer to the patch.  People will want to
536 google for the "summary phrase" to read discussion regarding that
537 patch.  It will also be the only thing that people may quickly see
538 when, two or three months later, they are going through perhaps
539 thousands of patches using tools such as "gitk" or "git log
540 --oneline".
541
542 For these reasons, the "summary" must be no more than 70-75
543 characters, and it must describe both what the patch changes, as well
544 as why the patch might be necessary.  It is challenging to be both
545 succinct and descriptive, but that is what a well-written summary
546 should do.
547
548 The "summary phrase" may be prefixed by tags enclosed in square
549 brackets: "Subject: [PATCH tag] <summary phrase>".  The tags are not
550 considered part of the summary phrase, but describe how the patch
551 should be treated.  Common tags might include a version descriptor if
552 the multiple versions of the patch have been sent out in response to
553 comments (i.e., "v1, v2, v3"), or "RFC" to indicate a request for
554 comments.  If there are four patches in a patch series the individual
555 patches may be numbered like this: 1/4, 2/4, 3/4, 4/4.  This assures
556 that developers understand the order in which the patches should be
557 applied and that they have reviewed or applied all of the patches in
558 the patch series.
559
560 A 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
564
565 The "from" line must be the very first line in the message body,
566 and has the form:
567
568         From: Original Author <author@example.com>
569
570 The "from" line specifies who will be credited as the author of the
571 patch in the permanent changelog.  If the "from" line is missing,
572 then the "From:" line from the email header will be used to determine
573 the patch author in the changelog.
574
575 The explanation body will be committed to the permanent source
576 changelog, so should make sense to a competent reader who has long
577 since forgotten the immediate details of the discussion that might
578 have led to this patch.  Including symptoms of the failure which the
579 patch addresses (kernel log messages, oops messages, etc.) is
580 especially useful for people who might be searching the commit logs
581 looking for the applicable patch.  If a patch fixes a compile failure,
582 it may not be necessary to include _all_ of the compile failures; just
583 enough that it is likely that someone searching for the patch can find
584 it.  As in the "summary phrase", it is important to be both succinct as
585 well as descriptive.
586
587 The "---" marker line serves the essential purpose of marking for patch
588 handling tools where the changelog message ends.
589
590 One good use for the additional comments after the "---" marker is for
591 a diffstat, to show what files have changed, and the number of
592 inserted and deleted lines per file.  A diffstat is especially useful
593 on bigger patches.  Other comments relevant only to the moment or the
594 maintainer, not suitable for the permanent changelog, should also go
595 here.  A good example of such comments might be "patch changelogs"
596 which describe what has changed between the v1 and v2 version of the
597 patch.
598
599 If you are going to include a diffstat after the "---" marker, please
600 use diffstat options "-p 1 -w 70" so that filenames are listed from
601 the top of the kernel source tree and don't use too much horizontal
602 space (easily fit in 80 columns, maybe with some indentation).
603
604 See more details on the proper patch format in the following
605 references.
606
607
608 16) Sending "git pull" requests  (from Linus emails)
609
610 Please write the git repo address and branch name alone on the same line
611 so that I can't even by mistake pull from the wrong branch, and so
612 that a triple-click just selects the whole thing.
613
614 So 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
622 so that I don't have to hunt-and-peck for the address and inevitably
623 get it wrong (actually, I've only gotten it wrong a few times, and
624 checking against the diffstat tells me when I get it wrong, but I'm
625 just a lot more comfortable when I don't have to "look for" the right
626 thing to pull, and double-check that I have the right branch-name).
627
628
629 Please use "git diff -M --stat --summary" to generate the diffstat:
630 the -M enables rename detection, and the summary enables a summary of
631 new/deleted or renamed files.
632
633 With rename detection, the statistics are rather different [...]
634 because git will notice that a fair number of the changes are renames.
635
636 -----------------------------------
637 SECTION 2 - HINTS, TIPS, AND TRICKS
638 -----------------------------------
639
640 This section lists many of the common "rules" associated with code
641 submitted to the kernel.  There are always exceptions... but you must
642 have a really good reason for doing so.  You could probably call this
643 section Linus Computer Science 101.
644
645
646
647 1) Read Documentation/CodingStyle
648
649 Nuff said.  If your code deviates too much from this, it is likely
650 to be rejected without further review, and without comment.
651
652 One significant exception is when moving code from one file to
653 another -- in this case you should not modify the moved code at all in
654 the same patch which moves it.  This clearly delineates the act of
655 moving the code and your changes.  This greatly aids review of the
656 actual differences and allows tools to better track the history of
657 the code itself.
658
659 Check your patches with the patch style checker prior to submission
660 (scripts/checkpatch.pl).  The style checker should be viewed as
661 a guide not as the final word.  If your code looks better with
662 a violation then its probably best left alone.
663
664 The 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
669 You should be able to justify all violations that remain in your
670 patch.
671
672
673
674 2) #ifdefs are ugly
675
676 Code cluttered with ifdefs is difficult to read and maintain.  Don't do
677 it.  Instead, put your ifdefs in a header, and conditionally define
678 'static inline' functions, or macros, which are used in the code.
679 Let the compiler optimize away the "no-op" case.
680
681 Simple 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
690 Cleaned-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
705 3) 'static inline' is better than a macro
706
707 Static inline functions are greatly preferred over macros.
708 They provide type safety, have no length limitations, no formatting
709 limitations, and under gcc they are as cheap as macros.
710
711 Macros should only be used for cases where a static inline is clearly
712 suboptimal [there are a few, isolated cases of this in fast paths],
713 or where it is impossible to use a static inline function [such as
714 string-izing].
715
716 'static inline' is preferred over 'static __inline__', 'extern inline',
717 and 'extern __inline__'.
718
719
720
721 4) Don't over-design.
722
723 Don't try to anticipate nebulous future cases which may or may not
724 be useful:  "Make it as simple as you can, and no simpler."
725
726
727
728 ----------------------
729 SECTION 3 - REFERENCES
730 ----------------------
731
732 Andrew Morton, "The perfect patch" (tpp).
733   <http://userweb.kernel.org/~akpm/stuff/tpp.txt>
734
735 Jeff Garzik, "Linux kernel patch submission format".
736   <http://linux.yyz.us/patch-format.html>
737
738 Greg Kroah-Hartman, "How to piss off a kernel subsystem maintainer".
739   <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>
744
745 NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people!
746   <http://marc.theaimsgroup.com/?l=linux-kernel&m=112112749912944&w=2>
747
748 Kernel Documentation/CodingStyle:
749   <http://users.sosdg.org/~qiyong/lxr/source/Documentation/CodingStyle>
750
751 Linus Torvalds's mail on the canonical patch format:
752   <http://lkml.org/lkml/2005/4/7/183>
753
754 Andi Kleen, "On submitting kernel patches"
755   Some strategies to get difficult or controversial changes in.
756   http://halobates.de/on-submitting-patches.pdf
757
758 --