@@ -15,62 +15,104 @@ to learn about how our community works. Reading these documents will make
1515it much easier for you to get your changes merged with a minimum of
1616trouble.
1717
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.
1923
2024.. toctree ::
2125 :maxdepth: 1
2226
23- license-rules
2427 howto
25- code-of-conduct
26- code-of-conduct-interpretation
2728 development-process
2829 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
3042 programming-language
3143 coding-style
32- maintainer-handbooks
3344 maintainer-pgp-guide
3445 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
3565 kernel-enforcement-statement
3666 kernel-driver-statement
67+ stable-api-nonsense
68+ stable-kernel-rules
69+ management-style
70+ researcher-guidelines
3771
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.
3978
4079.. toctree ::
4180 :maxdepth: 1
4281
82+ handling-regressions
4383 security-bugs
4484 embargoed-hardware-issues
4585
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:
47102
48103.. toctree ::
49104 :maxdepth: 1
50105
51- changes
52- stable-api-nonsense
53- management-style
54- stable-kernel-rules
55- submit-checklist
56106 kernel-docs
57107 deprecated
58- maintainers
59- researcher-guidelines
60- contribution-maturity-model
61108
62109These are some overall technical guides that have been put here for now for
63110lack of a better place.
64111
65112.. toctree ::
66113 :maxdepth: 1
67114
68- applying-patches
69- backporting
70- adding-syscalls
71115 magic-number
72- volatile-considered-harmful
73- botching-up-ioctls
74116 clang-format
75117 ../arch/riscv/patch-acceptance
76118 ../core-api/unaligned-memory-access
0 commit comments