xref: /linux/Documentation/process/index.rst (revision eed4edda910fe34dfae8c6bfbcf57f4593a54295)
1.. raw:: latex
2
3	\renewcommand\thesection*
4	\renewcommand\thesubsection*
5
6.. _process_index:
7
8=============================================
9Working with the kernel development community
10=============================================
11
12So you want to be a Linux kernel developer?  Welcome!  While there is a lot
13to be learned about the kernel in a technical sense, it is also important
14to learn about how our community works.  Reading these documents will make
15it much easier for you to get your changes merged with a minimum of
16trouble.
17
18An introduction to how kernel development works
19-----------------------------------------------
20
21Read these documents first: an understanding of the material here will ease
22your entry into the kernel community.
23
24.. toctree::
25   :maxdepth: 1
26
27   howto
28   development-process
29   submitting-patches
30   submit-checklist
31
32Tools and technical guides for kernel developers
33------------------------------------------------
34
35This is a collection of material that kernel developers should be familiar
36with.
37
38.. toctree::
39   :maxdepth: 1
40
41   changes
42   programming-language
43   coding-style
44   maintainer-pgp-guide
45   email-clients
46   applying-patches
47   backporting
48   adding-syscalls
49   volatile-considered-harmful
50   botching-up-ioctls
51
52Policy guides and developer statements
53--------------------------------------
54
55These are the rules that we try to live by in the kernel community (and
56beyond).
57
58.. toctree::
59   :maxdepth: 1
60
61   license-rules
62   code-of-conduct
63   code-of-conduct-interpretation
64   contribution-maturity-model
65   kernel-enforcement-statement
66   kernel-driver-statement
67   stable-api-nonsense
68   stable-kernel-rules
69   management-style
70   researcher-guidelines
71
72Dealing with bugs
73-----------------
74
75Bugs are a fact of life; it is important that we handle them properly.
76The documents below describe our policies around the handling of a couple
77of special classes of bugs: regressions and security problems.
78
79.. toctree::
80   :maxdepth: 1
81
82   handling-regressions
83   security-bugs
84   cve
85   embargoed-hardware-issues
86
87Maintainer information
88----------------------
89
90How to find the people who will accept your patches.
91
92.. toctree::
93   :maxdepth: 1
94
95   maintainer-handbooks
96   maintainers
97
98Other material
99--------------
100
101Here are some other guides to the community that are of interest to most
102developers:
103
104.. toctree::
105   :maxdepth: 1
106
107   kernel-docs
108   deprecated
109
110These are some overall technical guides that have been put here for now for
111lack of a better place.
112
113.. toctree::
114   :maxdepth: 1
115
116   magic-number
117   clang-format
118   ../arch/riscv/patch-acceptance
119   ../core-api/unaligned-memory-access
120
121.. only::  subproject and html
122
123   Indices
124   =======
125
126   * :ref:`genindex`
127