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