Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
A reworked process/index.rst
The process book is arguably the most important documentation we have; the
top three trafficked pages on docs.kernel.org are found here. Make a
beginning effort to impose a more useful organization on this page to ease
developers into the community.
Acked-by: Vegard Nossum <vegard.nossum@oracle.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
+72
-30
+72
-30
Documentation/process/index.rst
+72
-30
Documentation/process/index.rst
···
15
15
it much easier for you to get your changes merged with a minimum of
16
16
trouble.
17
17
18
-
Below are the essential guides that every developer should read.
18
+
An introduction to how kernel development works
19
+
-----------------------------------------------
20
+
21
+
Read these documents first: an understanding of the material here will ease
22
+
your entry into the kernel community.
19
23
20
24
.. toctree::
21
25
:maxdepth: 1
22
26
23
-
license-rules
24
27
howto
25
-
code-of-conduct
26
-
code-of-conduct-interpretation
27
28
development-process
28
29
submitting-patches
29
-
handling-regressions
30
-
programming-language
31
-
coding-style
32
-
maintainer-handbooks
33
-
maintainer-pgp-guide
34
-
email-clients
35
-
kernel-enforcement-statement
36
-
kernel-driver-statement
30
+
submit-checklist
37
31
38
-
For security issues, see:
32
+
Tools and technical guides for kernel developers
33
+
------------------------------------------------
39
34
40
-
.. toctree::
41
-
:maxdepth: 1
42
-
43
-
security-bugs
44
-
embargoed-hardware-issues
45
-
46
-
Other guides to the community that are of interest to most developers are:
35
+
This is a collection of material that kernel developers should be familiar
36
+
with.
47
37
48
38
.. toctree::
49
39
:maxdepth: 1
50
40
51
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
+
52
+
Policy guides and developer statements
53
+
--------------------------------------
54
+
55
+
These are the rules that we try to live by in the kernel community (and
56
+
beyond).
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
52
67
stable-api-nonsense
53
-
management-style
54
68
stable-kernel-rules
55
-
submit-checklist
69
+
management-style
70
+
researcher-guidelines
71
+
72
+
Dealing with bugs
73
+
-----------------
74
+
75
+
Bugs are a fact of life; it is important that we handle them properly.
76
+
The documents below describe our policies around the handling of a couple
77
+
of special classes of bugs: regressions and security problems.
78
+
79
+
.. toctree::
80
+
:maxdepth: 1
81
+
82
+
handling-regressions
83
+
security-bugs
84
+
embargoed-hardware-issues
85
+
86
+
Maintainer information
87
+
----------------------
88
+
89
+
How to find the people who will accept your patches.
90
+
91
+
.. toctree::
92
+
:maxdepth: 1
93
+
94
+
maintainer-handbooks
95
+
maintainers
96
+
97
+
Other material
98
+
--------------
99
+
100
+
Here are some other guides to the community that are of interest to most
101
+
developers:
102
+
103
+
.. toctree::
104
+
:maxdepth: 1
105
+
56
106
kernel-docs
57
107
deprecated
58
-
maintainers
59
-
researcher-guidelines
60
-
contribution-maturity-model
61
108
62
109
These are some overall technical guides that have been put here for now for
63
110
lack of a better place.
···
112
65
.. toctree::
113
66
:maxdepth: 1
114
67
115
-
applying-patches
116
-
backporting
117
-
adding-syscalls
118
68
magic-number
119
-
volatile-considered-harmful
120
-
botching-up-ioctls
121
69
clang-format
122
70
../arch/riscv/patch-acceptance
123
71
../core-api/unaligned-memory-access