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