blob: 82fc399fcd33d1628289ec5ccfeb3193a368c2fc [file] [log] [blame]
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -03001.. raw:: latex
2
3 \renewcommand\thesection*
4 \renewcommand\thesubsection*
5
Daniel Vettereadf71c2017-03-21 16:52:28 +01006.. _process_index:
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -03007
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -06008Working with the kernel development community
9=============================================
Mauro Carvalho Chehabf0ddda32016-09-19 08:07:38 -030010
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060011So you want to be a Linux kernel developer? Welcome! While there is a lot
12to be learned about the kernel in a technical sense, it is also important
13to learn about how our community works. Reading these documents will make
14it much easier for you to get your changes merged with a minimum of
15trouble.
16
17Below are the essential guides that every developer should read.
Mauro Carvalho Chehabf0ddda32016-09-19 08:07:38 -030018
19.. toctree::
Jonathan Corbetbe461242016-10-26 16:41:05 -060020 :maxdepth: 1
Mauro Carvalho Chehabf0ddda32016-09-19 08:07:38 -030021
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030022 howto
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060023 code-of-conflict
24 development-process
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030025 submitting-patches
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060026 coding-style
27 email-clients
28
29Other guides to the community that are of interest to most developers are:
30
31.. toctree::
Jonathan Corbetbe461242016-10-26 16:41:05 -060032 :maxdepth: 1
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060033
34 changes
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030035 submitting-drivers
36 stable-api-nonsense
37 management-style
38 stable-kernel-rules
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030039 submit-checklist
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060040 kernel-docs
41
42These are some overall technical guides that have been put here for now for
43lack of a better place.
44
45.. toctree::
Jonathan Corbetbe461242016-10-26 16:41:05 -060046 :maxdepth: 1
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060047
48 applying-patches
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030049 adding-syscalls
50 magic-number
51 volatile-considered-harmful
52
Markus Heiser6f2ec3a2016-10-26 08:23:16 +020053.. only:: subproject and html
54
55 Indices
56 =======
57
58 * :ref:`genindex`