@@ -15,62 +15,104 @@ to learn about how our community works. Reading these documents will make
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
+ submit-checklist
31
+
32
+ Tools and technical guides for kernel developers
33
+ ------------------------------------------------
34
+
35
+ This is a collection of material that kernel developers should be familiar
36
+ with.
37
+
38
+ .. toctree ::
39
+ :maxdepth: 1
40
+
41
+ changes
30
42
programming-language
31
43
coding-style
32
- maintainer-handbooks
33
44
maintainer-pgp-guide
34
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
35
65
kernel-enforcement-statement
36
66
kernel-driver-statement
67
+ stable-api-nonsense
68
+ stable-kernel-rules
69
+ management-style
70
+ researcher-guidelines
37
71
38
- For security issues, see:
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.
39
78
40
79
.. toctree ::
41
80
:maxdepth: 1
42
81
82
+ handling-regressions
43
83
security-bugs
44
84
embargoed-hardware-issues
45
85
46
- Other guides to the community that are of interest to most developers are:
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:
47
102
48
103
.. toctree ::
49
104
:maxdepth: 1
50
105
51
- changes
52
- stable-api-nonsense
53
- management-style
54
- stable-kernel-rules
55
- submit-checklist
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.
64
111
65
112
.. toctree ::
66
113
:maxdepth: 1
67
114
68
- applying-patches
69
- backporting
70
- adding-syscalls
71
115
magic-number
72
- volatile-considered-harmful
73
- botching-up-ioctls
74
116
clang-format
75
117
../arch/riscv/patch-acceptance
76
118
../core-api/unaligned-memory-access
0 commit comments