blob: 878ebfda7eeff378a2fee48e3b361aa6b3587896 [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
Markus Heiser97994452018-08-14 13:43:12 +020022 license-rules
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030023 howto
Greg Kroah-Hartman8a104f82018-09-15 20:26:44 +020024 code-of-conduct
Greg Kroah-Hartman79dbeed2018-10-14 16:16:47 +020025 code-of-conduct-interpretation
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060026 development-process
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030027 submitting-patches
Miguel Ojeda303d22c2018-09-03 18:32:11 +020028 programming-language
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060029 coding-style
Konstantin Ryabitsevb72dde32018-02-01 09:42:33 -050030 maintainer-pgp-guide
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060031 email-clients
Greg Kroah-Hartman9ed95122017-10-04 16:17:55 +020032 kernel-enforcement-statement
Greg Kroah-Hartman13277782017-10-06 11:10:38 +020033 kernel-driver-statement
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060034
35Other guides to the community that are of interest to most developers are:
36
37.. toctree::
Jonathan Corbetbe461242016-10-26 16:41:05 -060038 :maxdepth: 1
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060039
40 changes
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030041 submitting-drivers
42 stable-api-nonsense
43 management-style
44 stable-kernel-rules
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030045 submit-checklist
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060046 kernel-docs
Kees Cook84253c82018-10-17 16:45:32 -070047 deprecated
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060048
49These are some overall technical guides that have been put here for now for
50lack of a better place.
51
52.. toctree::
Jonathan Corbetbe461242016-10-26 16:41:05 -060053 :maxdepth: 1
Jonathan Corbet9b4ebd92016-10-26 16:34:09 -060054
55 applying-patches
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030056 adding-syscalls
57 magic-number
58 volatile-considered-harmful
Mauro Carvalho Chehab2d934042018-05-07 06:35:39 -030059 clang-format
Mauro Carvalho Chehab186128f2016-09-21 08:40:21 -030060
Markus Heiser6f2ec3a2016-10-26 08:23:16 +020061.. only:: subproject and html
62
63 Indices
64 =======
65
66 * :ref:`genindex`