blob: 10aa6920709a462789278f670eee8f8ea68cbc0c [file] [log] [blame]
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -03001.. raw:: latex
2
3 \renewcommand\thesection*
4 \renewcommand\thesubsection*
5
6
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -06007Working with the kernel development community
8=============================================
Mauro Carvalho Chehabf0ddda32016-09-19 08:07:38 -03009
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060010So you want to be a Linux kernel developer? Welcome! While there is a lot
11to be learned about the kernel in a technical sense, it is also important
12to learn about how our community works. Reading these documents will make
13it much easier for you to get your changes merged with a minimum of
14trouble.
15
16Below are the essential guides that every developer should read.
Mauro Carvalho Chehabf0ddda32016-09-19 08:07:38 -030017
18.. toctree::
Jonathan Corbetbe461242016-10-26 16:41:05 -060019 :maxdepth: 1
Mauro Carvalho Chehabf0ddda32016-09-19 08:07:38 -030020
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030021 howto
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060022 code-of-conflict
23 development-process
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030024 submitting-patches
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060025 coding-style
26 email-clients
27
28Other guides to the community that are of interest to most developers are:
29
30.. toctree::
Jonathan Corbetbe461242016-10-26 16:41:05 -060031 :maxdepth: 1
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060032
33 changes
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030034 submitting-drivers
35 stable-api-nonsense
36 management-style
37 stable-kernel-rules
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030038 submit-checklist
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060039 kernel-docs
40
41These are some overall technical guides that have been put here for now for
42lack of a better place.
43
44.. toctree::
Jonathan Corbetbe461242016-10-26 16:41:05 -060045 :maxdepth: 1
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060046
47 applying-patches
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030048 adding-syscalls
49 magic-number
50 volatile-considered-harmful
51
Markus Heiser6f2ec3a2016-10-26 08:23:16 +020052.. only:: subproject and html
53
54 Indices
55 =======
56
57 * :ref:`genindex`