xref: /linux/Documentation/process/index.rst (revision eb3dad518e4da48ab6c6df16aa8895b8b0bd6ecf)
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   conclave
72
73Dealing with bugs
74-----------------
75
76Bugs are a fact of life; it is important that we handle them properly. The
77documents below provide general advice about debugging and describe our
78policies around the handling of a couple of special classes of bugs:
79regressions and security problems.
80
81.. toctree::
82   :maxdepth: 1
83
84   debugging/index
85   handling-regressions
86   security-bugs
87   cve
88   embargoed-hardware-issues
89
90Maintainer information
91----------------------
92
93How to find the people who will accept your patches.
94
95.. toctree::
96   :maxdepth: 1
97
98   maintainer-handbooks
99   maintainers
100
101Other material
102--------------
103
104Here are some other guides to the community that are of interest to most
105developers:
106
107.. toctree::
108   :maxdepth: 1
109
110   kernel-docs
111   deprecated
112
113.. only::  subproject and html
114
115   Indices
116   =======
117
118   * :ref:`genindex`
119