Commit | Line | Data |
---|---|---|
4ef7f57e MCC |
1 | .. SPDX-License-Identifier: GPL-2.0 |
2 | ||
aa586e25 FV |
3 | .. _linux_doc: |
4 | ||
61ca5fd1 KR |
5 | The Linux Kernel documentation |
6 | ============================== | |
22cba31b | 7 | |
b51208d4 JC |
8 | This is the top level of the kernel's documentation tree. Kernel |
9 | documentation, like the kernel itself, is very much a work in progress; | |
10 | that is especially true as we work to integrate our many scattered | |
11 | documents into a coherent whole. Please note that improvements to the | |
12 | documentation are welcome; join the linux-doc list at vger.kernel.org if | |
13 | you want to help out. | |
14 | ||
0c7b4366 JC |
15 | Working with the development community |
16 | -------------------------------------- | |
aa19a176 | 17 | |
0c7b4366 JC |
18 | The essential guides for interacting with the kernel's development |
19 | community and getting your work upstream. | |
22cba31b JN |
20 | |
21 | .. toctree:: | |
0c7b4366 | 22 | :maxdepth: 1 |
680e6ffa | 23 | |
0c7b4366 JC |
24 | process/development-process |
25 | process/submitting-patches | |
26 | Code of conduct <process/code-of-conduct> | |
27 | maintainer/index | |
28 | All development-process docs <process/index> | |
680e6ffa | 29 | |
680e6ffa | 30 | |
0c7b4366 JC |
31 | Internal API manuals |
32 | -------------------- | |
1d596dee | 33 | |
0c7b4366 JC |
34 | Manuals for use by developers working to interface with the rest of the |
35 | kernel. | |
1d596dee JC |
36 | |
37 | .. toctree:: | |
0c7b4366 | 38 | :maxdepth: 1 |
1d596dee | 39 | |
0c7b4366 JC |
40 | core-api/index |
41 | driver-api/index | |
42 | subsystem-apis | |
43 | Locking in the kernel <locking/index> | |
1d596dee | 44 | |
0c7b4366 JC |
45 | Development tools and processes |
46 | ------------------------------- | |
b51208d4 | 47 | |
0c7b4366 | 48 | Various other manuals with useful information for all kernel developers. |
b51208d4 JC |
49 | |
50 | .. toctree:: | |
0c7b4366 | 51 | :maxdepth: 1 |
b51208d4 | 52 | |
0c7b4366 | 53 | process/license-rules |
1dc4bbf0 | 54 | doc-guide/index |
0c7b4366 JC |
55 | dev-tools/index |
56 | dev-tools/testing-overview | |
c4fcd7ca | 57 | kernel-hacking/index |
583bc6ba | 58 | trace/index |
113094f7 MCC |
59 | fault-injection/index |
60 | livepatch/index | |
d07479b2 | 61 | rust/index |
113094f7 | 62 | |
b51208d4 | 63 | |
0c7b4366 JC |
64 | User-oriented documentation |
65 | --------------------------- | |
b51208d4 | 66 | |
0c7b4366 JC |
67 | The following manuals are written for *users* of the kernel — those who are |
68 | trying to get it to work optimally on a given system and application | |
69 | developers seeking information on the kernel's user-space APIs. | |
b51208d4 JC |
70 | |
71 | .. toctree:: | |
0c7b4366 JC |
72 | :maxdepth: 1 |
73 | ||
74 | admin-guide/index | |
75 | The kernel build system <kbuild/index> | |
76 | admin-guide/reporting-issues.rst | |
77 | User-space tools <tools/index> | |
78 | userspace-api/index | |
79 | ||
48987606 JC |
80 | See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_, |
81 | which are kept separately from the kernel's own documentation. | |
0c7b4366 JC |
82 | |
83 | Firmware-related documentation | |
84 | ------------------------------ | |
85 | The following holds information on the kernel's expectations regarding the | |
86 | platform firmwares. | |
87 | ||
88 | .. toctree:: | |
89 | :maxdepth: 1 | |
90 | ||
91 | firmware-guide/index | |
92 | devicetree/index | |
b51208d4 | 93 | |
22cba31b | 94 | |
bffac837 MCC |
95 | Architecture-specific documentation |
96 | ----------------------------------- | |
97 | ||
bffac837 MCC |
98 | .. toctree:: |
99 | :maxdepth: 2 | |
100 | ||
3eca1cfb JN |
101 | arch |
102 | ||
bffac837 | 103 | |
8e2a46a4 MCC |
104 | Other documentation |
105 | ------------------- | |
106 | ||
107 | There are several unsorted documents that don't seem to fit on other parts | |
108 | of the documentation body, or may require some adjustments and/or conversion | |
109 | to ReStructured Text format, or are simply too old. | |
110 | ||
111 | .. toctree:: | |
0c7b4366 | 112 | :maxdepth: 1 |
8e2a46a4 MCC |
113 | |
114 | staging/index | |
115 | ||
116 | ||
85c32d9c FV |
117 | Translations |
118 | ------------ | |
2069889f AD |
119 | |
120 | .. toctree:: | |
85c32d9c | 121 | :maxdepth: 2 |
f0127338 | 122 | |
85c32d9c | 123 | translations/index |
f0127338 | 124 | |
22cba31b JN |
125 | Indices and tables |
126 | ================== | |
127 | ||
128 | * :ref:`genindex` |