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