Merge remote-tracking branch 'origin/android-tegra-nv-3.1' into android-t114-3.4
[linux-2.6.git] / Documentation / HOWTO
1 HOWTO do Linux kernel development
2 ---------------------------------
3
4 This is the be-all, end-all document on this topic.  It contains
5 instructions on how to become a Linux kernel developer and how to learn
6 to work with the Linux kernel development community.  It tries to not
7 contain anything related to the technical aspects of kernel programming,
8 but will help point you in the right direction for that.
9
10 If anything in this document becomes out of date, please send in patches
11 to the maintainer of this file, who is listed at the bottom of the
12 document.
13
14 Introduction
15 ------------
16
17 So, you want to learn how to become a Linux kernel developer?  Or you
18 have been told by your manager, "Go write a Linux driver for this
19 device."  This document's goal is to teach you everything you need to
20 know to achieve this by describing the process you need to go through,
21 and hints on how to work with the community.  It will also try to
22 explain some of the reasons why the community works like it does.
23
24 The kernel is written mostly in C, with some architecture-dependent
25 parts written in assembly. A good understanding of C is required for
26 kernel development.  Assembly (any architecture) is not required unless
27 you plan to do low-level development for that architecture.  Though they
28 are not a good substitute for a solid C education and/or years of
29 experience, the following books are good for, if anything, reference:
30  - "The C Programming Language" by Kernighan and Ritchie [Prentice Hall]
31  - "Practical C Programming" by Steve Oualline [O'Reilly]
32  - "C:  A Reference Manual" by Harbison and Steele [Prentice Hall]
33
34 The kernel is written using GNU C and the GNU toolchain.  While it
35 adheres to the ISO C89 standard, it uses a number of extensions that are
36 not featured in the standard.  The kernel is a freestanding C
37 environment, with no reliance on the standard C library, so some
38 portions of the C standard are not supported.  Arbitrary long long
39 divisions and floating point are not allowed.  It can sometimes be
40 difficult to understand the assumptions the kernel has on the toolchain
41 and the extensions that it uses, and unfortunately there is no
42 definitive reference for them.  Please check the gcc info pages (`info
43 gcc`) for some information on them.
44
45 Please remember that you are trying to learn how to work with the
46 existing development community.  It is a diverse group of people, with
47 high standards for coding, style and procedure.  These standards have
48 been created over time based on what they have found to work best for
49 such a large and geographically dispersed team.  Try to learn as much as
50 possible about these standards ahead of time, as they are well
51 documented; do not expect people to adapt to you or your company's way
52 of doing things.
53
54 Legal Issues
55 ------------
56
57 The Linux kernel source code is released under the GPL.  Please see the
58 file, COPYING, in the main directory of the source tree, for details on
59 the license.  If you have further questions about the license, please
60 contact a lawyer, and do not ask on the Linux kernel mailing list.  The
61 people on the mailing lists are not lawyers, and you should not rely on
62 their statements on legal matters.
63
64 For common questions and answers about the GPL, please see:
65         http://www.gnu.org/licenses/gpl-faq.html
66
67 Documentation
68 ------------
69
70 The Linux kernel source tree has a large range of documents that are
71 invaluable for learning how to interact with the kernel community.  When
72 new features are added to the kernel, it is recommended that new
73 documentation files are also added which explain how to use the feature.
74 When a kernel change causes the interface that the kernel exposes to
75 userspace to change, it is recommended that you send the information or
76 a patch to the manual pages explaining the change to the manual pages
77 maintainer at mtk.manpages@gmail.com, and CC the list
78 linux-api@vger.kernel.org.
79
80 Here is a list of files that are in the kernel source tree that are
81 required reading:
82   README
83     This file gives a short background on the Linux kernel and describes
84     what is necessary to do to configure and build the kernel.  People
85     who are new to the kernel should start here.
86
87   Documentation/Changes
88     This file gives a list of the minimum levels of various software
89     packages that are necessary to build and run the kernel
90     successfully.
91
92   Documentation/CodingStyle
93     This describes the Linux kernel coding style, and some of the
94     rationale behind it. All new code is expected to follow the
95     guidelines in this document. Most maintainers will only accept
96     patches if these rules are followed, and many people will only
97     review code if it is in the proper style.
98
99   Documentation/SubmittingPatches
100   Documentation/SubmittingDrivers
101     These files describe in explicit detail how to successfully create
102     and send a patch, including (but not limited to):
103        - Email contents
104        - Email format
105        - Who to send it to
106     Following these rules will not guarantee success (as all patches are
107     subject to scrutiny for content and style), but not following them
108     will almost always prevent it.
109
110     Other excellent descriptions of how to create patches properly are:
111         "The Perfect Patch"
112                 http://userweb.kernel.org/~akpm/stuff/tpp.txt
113         "Linux kernel patch submission format"
114                 http://linux.yyz.us/patch-format.html
115
116   Documentation/stable_api_nonsense.txt
117     This file describes the rationale behind the conscious decision to
118     not have a stable API within the kernel, including things like:
119       - Subsystem shim-layers (for compatibility?)
120       - Driver portability between Operating Systems.
121       - Mitigating rapid change within the kernel source tree (or
122         preventing rapid change)
123     This document is crucial for understanding the Linux development
124     philosophy and is very important for people moving to Linux from
125     development on other Operating Systems.
126
127   Documentation/SecurityBugs
128     If you feel you have found a security problem in the Linux kernel,
129     please follow the steps in this document to help notify the kernel
130     developers, and help solve the issue.
131
132   Documentation/ManagementStyle
133     This document describes how Linux kernel maintainers operate and the
134     shared ethos behind their methodologies.  This is important reading
135     for anyone new to kernel development (or anyone simply curious about
136     it), as it resolves a lot of common misconceptions and confusion
137     about the unique behavior of kernel maintainers.
138
139   Documentation/stable_kernel_rules.txt
140     This file describes the rules on how the stable kernel releases
141     happen, and what to do if you want to get a change into one of these
142     releases.
143
144   Documentation/kernel-docs.txt
145     A list of external documentation that pertains to kernel
146     development.  Please consult this list if you do not find what you
147     are looking for within the in-kernel documentation.
148
149   Documentation/applying-patches.txt
150     A good introduction describing exactly what a patch is and how to
151     apply it to the different development branches of the kernel.
152
153 The kernel also has a large number of documents that can be
154 automatically generated from the source code itself.  This includes a
155 full description of the in-kernel API, and rules on how to handle
156 locking properly.  The documents will be created in the
157 Documentation/DocBook/ directory and can be generated as PDF,
158 Postscript, HTML, and man pages by running:
159         make pdfdocs
160         make psdocs
161         make htmldocs
162         make mandocs
163 respectively from the main kernel source directory.
164
165
166 Becoming A Kernel Developer
167 ---------------------------
168
169 If you do not know anything about Linux kernel development, you should
170 look at the Linux KernelNewbies project:
171         http://kernelnewbies.org
172 It consists of a helpful mailing list where you can ask almost any type
173 of basic kernel development question (make sure to search the archives
174 first, before asking something that has already been answered in the
175 past.)  It also has an IRC channel that you can use to ask questions in
176 real-time, and a lot of helpful documentation that is useful for
177 learning about Linux kernel development.
178
179 The website has basic information about code organization, subsystems,
180 and current projects (both in-tree and out-of-tree). It also describes
181 some basic logistical information, like how to compile a kernel and
182 apply a patch.
183
184 If you do not know where you want to start, but you want to look for
185 some task to start doing to join into the kernel development community,
186 go to the Linux Kernel Janitor's project:
187         http://kernelnewbies.org/KernelJanitors
188 It is a great place to start.  It describes a list of relatively simple
189 problems that need to be cleaned up and fixed within the Linux kernel
190 source tree.  Working with the developers in charge of this project, you
191 will learn the basics of getting your patch into the Linux kernel tree,
192 and possibly be pointed in the direction of what to go work on next, if
193 you do not already have an idea.
194
195 If you already have a chunk of code that you want to put into the kernel
196 tree, but need some help getting it in the proper form, the
197 kernel-mentors project was created to help you out with this.  It is a
198 mailing list, and can be found at:
199         http://selenic.com/mailman/listinfo/kernel-mentors
200
201 Before making any actual modifications to the Linux kernel code, it is
202 imperative to understand how the code in question works.  For this
203 purpose, nothing is better than reading through it directly (most tricky
204 bits are commented well), perhaps even with the help of specialized
205 tools.  One such tool that is particularly recommended is the Linux
206 Cross-Reference project, which is able to present source code in a
207 self-referential, indexed webpage format. An excellent up-to-date
208 repository of the kernel code may be found at:
209         http://lxr.linux.no/+trees
210
211
212 The development process
213 -----------------------
214
215 Linux kernel development process currently consists of a few different
216 main kernel "branches" and lots of different subsystem-specific kernel
217 branches.  These different branches are:
218   - main 3.x kernel tree
219   - 3.x.y -stable kernel tree
220   - 3.x -git kernel patches
221   - subsystem specific kernel trees and patches
222   - the 3.x -next kernel tree for integration tests
223
224 3.x kernel tree
225 -----------------
226 3.x kernels are maintained by Linus Torvalds, and can be found on
227 kernel.org in the pub/linux/kernel/v3.x/ directory.  Its development
228 process is as follows:
229   - As soon as a new kernel is released a two weeks window is open,
230     during this period of time maintainers can submit big diffs to
231     Linus, usually the patches that have already been included in the
232     -next kernel for a few weeks.  The preferred way to submit big changes
233     is using git (the kernel's source management tool, more information
234     can be found at http://git-scm.com/) but plain patches are also just
235     fine.
236   - After two weeks a -rc1 kernel is released it is now possible to push
237     only patches that do not include new features that could affect the
238     stability of the whole kernel.  Please note that a whole new driver
239     (or filesystem) might be accepted after -rc1 because there is no
240     risk of causing regressions with such a change as long as the change
241     is self-contained and does not affect areas outside of the code that
242     is being added.  git can be used to send patches to Linus after -rc1
243     is released, but the patches need to also be sent to a public
244     mailing list for review.
245   - A new -rc is released whenever Linus deems the current git tree to
246     be in a reasonably sane state adequate for testing.  The goal is to
247     release a new -rc kernel every week.
248   - Process continues until the kernel is considered "ready", the
249     process should last around 6 weeks.
250   - Known regressions in each release are periodically posted to the
251     linux-kernel mailing list.  The goal is to reduce the length of
252     that list to zero before declaring the kernel to be "ready," but, in
253     the real world, a small number of regressions often remain at
254     release time.
255
256 It is worth mentioning what Andrew Morton wrote on the linux-kernel
257 mailing list about kernel releases:
258         "Nobody knows when a kernel will be released, because it's
259         released according to perceived bug status, not according to a
260         preconceived timeline."
261
262 3.x.y -stable kernel tree
263 ---------------------------
264 Kernels with 3-part versions are -stable kernels. They contain
265 relatively small and critical fixes for security problems or significant
266 regressions discovered in a given 3.x kernel.
267
268 This is the recommended branch for users who want the most recent stable
269 kernel and are not interested in helping test development/experimental
270 versions.
271
272 If no 3.x.y kernel is available, then the highest numbered 3.x
273 kernel is the current stable kernel.
274
275 3.x.y are maintained by the "stable" team <stable@vger.kernel.org>, and
276 are released as needs dictate.  The normal release period is approximately
277 two weeks, but it can be longer if there are no pressing problems.  A
278 security-related problem, instead, can cause a release to happen almost
279 instantly.
280
281 The file Documentation/stable_kernel_rules.txt in the kernel tree
282 documents what kinds of changes are acceptable for the -stable tree, and
283 how the release process works.
284
285 3.x -git patches
286 ------------------
287 These are daily snapshots of Linus' kernel tree which are managed in a
288 git repository (hence the name.) These patches are usually released
289 daily and represent the current state of Linus' tree.  They are more
290 experimental than -rc kernels since they are generated automatically
291 without even a cursory glance to see if they are sane.
292
293 Subsystem Specific kernel trees and patches
294 -------------------------------------------
295 The maintainers of the various kernel subsystems --- and also many
296 kernel subsystem developers --- expose their current state of
297 development in source repositories.  That way, others can see what is
298 happening in the different areas of the kernel.  In areas where
299 development is rapid, a developer may be asked to base his submissions
300 onto such a subsystem kernel tree so that conflicts between the
301 submission and other already ongoing work are avoided.
302
303 Most of these repositories are git trees, but there are also other SCMs
304 in use, or patch queues being published as quilt series.  Addresses of
305 these subsystem repositories are listed in the MAINTAINERS file.  Many
306 of them can be browsed at http://git.kernel.org/.
307
308 Before a proposed patch is committed to such a subsystem tree, it is
309 subject to review which primarily happens on mailing lists (see the
310 respective section below).  For several kernel subsystems, this review
311 process is tracked with the tool patchwork.  Patchwork offers a web
312 interface which shows patch postings, any comments on a patch or
313 revisions to it, and maintainers can mark patches as under review,
314 accepted, or rejected.  Most of these patchwork sites are listed at
315 http://patchwork.kernel.org/.
316
317 3.x -next kernel tree for integration tests
318 ---------------------------------------------
319 Before updates from subsystem trees are merged into the mainline 3.x
320 tree, they need to be integration-tested.  For this purpose, a special
321 testing repository exists into which virtually all subsystem trees are
322 pulled on an almost daily basis:
323         http://git.kernel.org/?p=linux/kernel/git/next/linux-next.git
324         http://linux.f-seidel.de/linux-next/pmwiki/
325
326 This way, the -next kernel gives a summary outlook onto what will be
327 expected to go into the mainline kernel at the next merge period.
328 Adventurous testers are very welcome to runtime-test the -next kernel.
329
330
331 Bug Reporting
332 -------------
333
334 bugzilla.kernel.org is where the Linux kernel developers track kernel
335 bugs.  Users are encouraged to report all bugs that they find in this
336 tool.  For details on how to use the kernel bugzilla, please see:
337         http://bugzilla.kernel.org/page.cgi?id=faq.html
338
339 The file REPORTING-BUGS in the main kernel source directory has a good
340 template for how to report a possible kernel bug, and details what kind
341 of information is needed by the kernel developers to help track down the
342 problem.
343
344
345 Managing bug reports
346 --------------------
347
348 One of the best ways to put into practice your hacking skills is by fixing
349 bugs reported by other people. Not only you will help to make the kernel
350 more stable, you'll learn to fix real world problems and you will improve
351 your skills, and other developers will be aware of your presence. Fixing
352 bugs is one of the best ways to get merits among other developers, because
353 not many people like wasting time fixing other people's bugs.
354
355 To work in the already reported bug reports, go to http://bugzilla.kernel.org.
356 If you want to be advised of the future bug reports, you can subscribe to the
357 bugme-new mailing list (only new bug reports are mailed here) or to the
358 bugme-janitor mailing list (every change in the bugzilla is mailed here)
359
360         http://lists.linux-foundation.org/mailman/listinfo/bugme-new
361         http://lists.linux-foundation.org/mailman/listinfo/bugme-janitors
362
363
364
365 Mailing lists
366 -------------
367
368 As some of the above documents describe, the majority of the core kernel
369 developers participate on the Linux Kernel Mailing list.  Details on how
370 to subscribe and unsubscribe from the list can be found at:
371         http://vger.kernel.org/vger-lists.html#linux-kernel
372 There are archives of the mailing list on the web in many different
373 places.  Use a search engine to find these archives.  For example:
374         http://dir.gmane.org/gmane.linux.kernel
375 It is highly recommended that you search the archives about the topic
376 you want to bring up, before you post it to the list. A lot of things
377 already discussed in detail are only recorded at the mailing list
378 archives.
379
380 Most of the individual kernel subsystems also have their own separate
381 mailing list where they do their development efforts.  See the
382 MAINTAINERS file for a list of what these lists are for the different
383 groups.
384
385 Many of the lists are hosted on kernel.org. Information on them can be
386 found at:
387         http://vger.kernel.org/vger-lists.html
388
389 Please remember to follow good behavioral habits when using the lists.
390 Though a bit cheesy, the following URL has some simple guidelines for
391 interacting with the list (or any list):
392         http://www.albion.com/netiquette/
393
394 If multiple people respond to your mail, the CC: list of recipients may
395 get pretty large. Don't remove anybody from the CC: list without a good
396 reason, or don't reply only to the list address. Get used to receiving the
397 mail twice, one from the sender and the one from the list, and don't try
398 to tune that by adding fancy mail-headers, people will not like it.
399
400 Remember to keep the context and the attribution of your replies intact,
401 keep the "John Kernelhacker wrote ...:" lines at the top of your reply, and
402 add your statements between the individual quoted sections instead of
403 writing at the top of the mail.
404
405 If you add patches to your mail, make sure they are plain readable text
406 as stated in Documentation/SubmittingPatches. Kernel developers don't
407 want to deal with attachments or compressed patches; they may want
408 to comment on individual lines of your patch, which works only that way.
409 Make sure you use a mail program that does not mangle spaces and tab
410 characters. A good first test is to send the mail to yourself and try
411 to apply your own patch by yourself. If that doesn't work, get your
412 mail program fixed or change it until it works.
413
414 Above all, please remember to show respect to other subscribers.
415
416
417 Working with the community
418 --------------------------
419
420 The goal of the kernel community is to provide the best possible kernel
421 there is.  When you submit a patch for acceptance, it will be reviewed
422 on its technical merits and those alone.  So, what should you be
423 expecting?
424   - criticism
425   - comments
426   - requests for change
427   - requests for justification
428   - silence
429
430 Remember, this is part of getting your patch into the kernel.  You have
431 to be able to take criticism and comments about your patches, evaluate
432 them at a technical level and either rework your patches or provide
433 clear and concise reasoning as to why those changes should not be made.
434 If there are no responses to your posting, wait a few days and try
435 again, sometimes things get lost in the huge volume.
436
437 What should you not do?
438   - expect your patch to be accepted without question
439   - become defensive
440   - ignore comments
441   - resubmit the patch without making any of the requested changes
442
443 In a community that is looking for the best technical solution possible,
444 there will always be differing opinions on how beneficial a patch is.
445 You have to be cooperative, and willing to adapt your idea to fit within
446 the kernel.  Or at least be willing to prove your idea is worth it.
447 Remember, being wrong is acceptable as long as you are willing to work
448 toward a solution that is right.
449
450 It is normal that the answers to your first patch might simply be a list
451 of a dozen things you should correct.  This does _not_ imply that your
452 patch will not be accepted, and it is _not_ meant against you
453 personally.  Simply correct all issues raised against your patch and
454 resend it.
455
456
457 Differences between the kernel community and corporate structures
458 -----------------------------------------------------------------
459
460 The kernel community works differently than most traditional corporate
461 development environments.  Here are a list of things that you can try to
462 do to try to avoid problems:
463   Good things to say regarding your proposed changes:
464     - "This solves multiple problems."
465     - "This deletes 2000 lines of code."
466     - "Here is a patch that explains what I am trying to describe."
467     - "I tested it on 5 different architectures..."
468     - "Here is a series of small patches that..."
469     - "This increases performance on typical machines..."
470
471   Bad things you should avoid saying:
472     - "We did it this way in AIX/ptx/Solaris, so therefore it must be
473       good..."
474     - "I've being doing this for 20 years, so..."
475     - "This is required for my company to make money"
476     - "This is for our Enterprise product line."
477     - "Here is my 1000 page design document that describes my idea"
478     - "I've been working on this for 6 months..."
479     - "Here's a 5000 line patch that..."
480     - "I rewrote all of the current mess, and here it is..."
481     - "I have a deadline, and this patch needs to be applied now."
482
483 Another way the kernel community is different than most traditional
484 software engineering work environments is the faceless nature of
485 interaction.  One benefit of using email and irc as the primary forms of
486 communication is the lack of discrimination based on gender or race.
487 The Linux kernel work environment is accepting of women and minorities
488 because all you are is an email address.  The international aspect also
489 helps to level the playing field because you can't guess gender based on
490 a person's name. A man may be named Andrea and a woman may be named Pat.
491 Most women who have worked in the Linux kernel and have expressed an
492 opinion have had positive experiences.
493
494 The language barrier can cause problems for some people who are not
495 comfortable with English.  A good grasp of the language can be needed in
496 order to get ideas across properly on mailing lists, so it is
497 recommended that you check your emails to make sure they make sense in
498 English before sending them.
499
500
501 Break up your changes
502 ---------------------
503
504 The Linux kernel community does not gladly accept large chunks of code
505 dropped on it all at once.  The changes need to be properly introduced,
506 discussed, and broken up into tiny, individual portions.  This is almost
507 the exact opposite of what companies are used to doing.  Your proposal
508 should also be introduced very early in the development process, so that
509 you can receive feedback on what you are doing.  It also lets the
510 community feel that you are working with them, and not simply using them
511 as a dumping ground for your feature.  However, don't send 50 emails at
512 one time to a mailing list, your patch series should be smaller than
513 that almost all of the time.
514
515 The reasons for breaking things up are the following:
516
517 1) Small patches increase the likelihood that your patches will be
518    applied, since they don't take much time or effort to verify for
519    correctness.  A 5 line patch can be applied by a maintainer with
520    barely a second glance. However, a 500 line patch may take hours to
521    review for correctness (the time it takes is exponentially
522    proportional to the size of the patch, or something).
523
524    Small patches also make it very easy to debug when something goes
525    wrong.  It's much easier to back out patches one by one than it is
526    to dissect a very large patch after it's been applied (and broken
527    something).
528
529 2) It's important not only to send small patches, but also to rewrite
530    and simplify (or simply re-order) patches before submitting them.
531
532 Here is an analogy from kernel developer Al Viro:
533         "Think of a teacher grading homework from a math student.  The
534         teacher does not want to see the student's trials and errors
535         before they came up with the solution. They want to see the
536         cleanest, most elegant answer.  A good student knows this, and
537         would never submit her intermediate work before the final
538         solution."
539
540         The same is true of kernel development. The maintainers and
541         reviewers do not want to see the thought process behind the
542         solution to the problem one is solving. They want to see a
543         simple and elegant solution."
544
545 It may be challenging to keep the balance between presenting an elegant
546 solution and working together with the community and discussing your
547 unfinished work. Therefore it is good to get early in the process to
548 get feedback to improve your work, but also keep your changes in small
549 chunks that they may get already accepted, even when your whole task is
550 not ready for inclusion now.
551
552 Also realize that it is not acceptable to send patches for inclusion
553 that are unfinished and will be "fixed up later."
554
555
556 Justify your change
557 -------------------
558
559 Along with breaking up your patches, it is very important for you to let
560 the Linux community know why they should add this change.  New features
561 must be justified as being needed and useful.
562
563
564 Document your change
565 --------------------
566
567 When sending in your patches, pay special attention to what you say in
568 the text in your email.  This information will become the ChangeLog
569 information for the patch, and will be preserved for everyone to see for
570 all time.  It should describe the patch completely, containing:
571   - why the change is necessary
572   - the overall design approach in the patch
573   - implementation details
574   - testing results
575
576 For more details on what this should all look like, please see the
577 ChangeLog section of the document:
578   "The Perfect Patch"
579       http://userweb.kernel.org/~akpm/stuff/tpp.txt
580
581
582
583
584 All of these things are sometimes very hard to do. It can take years to
585 perfect these practices (if at all). It's a continuous process of
586 improvement that requires a lot of patience and determination. But
587 don't give up, it's possible. Many have done it before, and each had to
588 start exactly where you are now.
589
590
591
592
593 ----------
594 Thanks to Paolo Ciarrocchi who allowed the "Development Process"
595 (http://lwn.net/Articles/94386/) section
596 to be based on text he had written, and to Randy Dunlap and Gerrit
597 Huizenga for some of the list of things you should and should not say.
598 Also thanks to Pat Mochel, Hanna Linder, Randy Dunlap, Kay Sievers,
599 Vojtech Pavlik, Jan Kara, Josh Boyer, Kees Cook, Andrew Morton, Andi
600 Kleen, Vadim Lobanov, Jesper Juhl, Adrian Bunk, Keri Harris, Frans Pop,
601 David A. Wheeler, Junio Hamano, Michael Kerrisk, and Alex Shepard for
602 their review, comments, and contributions.  Without their help, this
603 document would not have been possible.
604
605
606
607 Maintainer: Greg Kroah-Hartman <greg@kroah.com>