blob: 1c9fe657ed01b049e3e8a963177cbd85f63c180c [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
Konstantin Ryabitsevb72dde32018-02-01 09:42:33 -050027 maintainer-pgp-guide
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060028 email-clients
Greg Kroah-Hartman9ed95122017-10-04 16:17:55 +020029 kernel-enforcement-statement
Greg Kroah-Hartman13277782017-10-06 11:10:38 +020030 kernel-driver-statement
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060031
32Other guides to the community that are of interest to most developers are:
33
34.. toctree::
Jonathan Corbetbe461242016-10-26 16:41:05 -060035 :maxdepth: 1
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060036
37 changes
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030038 submitting-drivers
39 stable-api-nonsense
40 management-style
41 stable-kernel-rules
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030042 submit-checklist
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060043 kernel-docs
44
45These are some overall technical guides that have been put here for now for
46lack of a better place.
47
48.. toctree::
Jonathan Corbetbe461242016-10-26 16:41:05 -060049 :maxdepth: 1
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060050
51 applying-patches
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030052 adding-syscalls
53 magic-number
54 volatile-considered-harmful
55
Markus Heiser6f2ec3a2016-10-26 08:23:16 +020056.. only:: subproject and html
57
58 Indices
59 =======
60
61 * :ref:`genindex`