]>
Commit | Line | Data |
---|---|---|
4ef7f57e MCC |
1 | .. SPDX-License-Identifier: GPL-2.0 |
2 | ||
dc7a12bd | 3 | |
22cba31b JN |
4 | .. The Linux Kernel documentation master file, created by |
5 | sphinx-quickstart on Fri Feb 12 13:51:46 2016. | |
6 | You can adapt this file completely to your liking, but it should at least | |
7 | contain the root `toctree` directive. | |
8 | ||
aa586e25 FV |
9 | .. _linux_doc: |
10 | ||
61ca5fd1 KR |
11 | The Linux Kernel documentation |
12 | ============================== | |
22cba31b | 13 | |
b51208d4 JC |
14 | This is the top level of the kernel's documentation tree. Kernel |
15 | documentation, like the kernel itself, is very much a work in progress; | |
16 | that is especially true as we work to integrate our many scattered | |
17 | documents into a coherent whole. Please note that improvements to the | |
18 | documentation are welcome; join the linux-doc list at vger.kernel.org if | |
19 | you want to help out. | |
20 | ||
aa19a176 TG |
21 | Licensing documentation |
22 | ----------------------- | |
23 | ||
24 | The following describes the license of the Linux kernel source code | |
25 | (GPLv2), how to properly mark the license of individual files in the source | |
26 | tree, as well as links to the full license text. | |
27 | ||
9799445a | 28 | * :ref:`kernel_licensing` |
aa19a176 | 29 | |
b51208d4 JC |
30 | User-oriented documentation |
31 | --------------------------- | |
32 | ||
33 | The following manuals are written for *users* of the kernel — those who are | |
34 | trying to get it to work optimally on a given system. | |
22cba31b JN |
35 | |
36 | .. toctree:: | |
37 | :maxdepth: 2 | |
38 | ||
9d85025b | 39 | admin-guide/index |
113094f7 | 40 | kbuild/index |
b51208d4 | 41 | |
680e6ffa CD |
42 | Firmware-related documentation |
43 | ------------------------------ | |
44 | The following holds information on the kernel's expectations regarding the | |
45 | platform firmwares. | |
46 | ||
47 | .. toctree:: | |
48 | :maxdepth: 2 | |
49 | ||
50 | firmware-guide/index | |
4ef7f57e | 51 | devicetree/index |
680e6ffa | 52 | |
1d596dee JC |
53 | Application-developer documentation |
54 | ----------------------------------- | |
55 | ||
56 | The user-space API manual gathers together documents describing aspects of | |
57 | the kernel interface as seen by application developers. | |
58 | ||
59 | .. toctree:: | |
60 | :maxdepth: 2 | |
61 | ||
82381918 | 62 | userspace-api/index |
1d596dee JC |
63 | |
64 | ||
b51208d4 JC |
65 | Introduction to kernel development |
66 | ---------------------------------- | |
67 | ||
68 | These manuals contain overall information about how to develop the kernel. | |
69 | The kernel community is quite large, with thousands of developers | |
70 | contributing over the course of a year. As with any large community, | |
71 | knowing how things are done will make the process of getting your changes | |
72 | merged much easier. | |
73 | ||
74 | .. toctree:: | |
75 | :maxdepth: 2 | |
76 | ||
0e4f07a6 | 77 | process/index |
c289312f | 78 | dev-tools/index |
1dc4bbf0 | 79 | doc-guide/index |
c4fcd7ca | 80 | kernel-hacking/index |
583bc6ba | 81 | trace/index |
9727a014 | 82 | maintainer/index |
113094f7 MCC |
83 | fault-injection/index |
84 | livepatch/index | |
85 | ||
b51208d4 JC |
86 | |
87 | Kernel API documentation | |
88 | ------------------------ | |
89 | ||
90 | These books get into the details of how specific kernel subsystems work | |
91 | from the point of view of a kernel developer. Much of the information here | |
92 | is taken directly from the kernel source, with supplemental material added | |
93 | as needed (or at least as we managed to add it — probably *not* all that is | |
2069889f | 94 | needed). |
b51208d4 JC |
95 | |
96 | .. toctree:: | |
97 | :maxdepth: 2 | |
98 | ||
dcec3c8c | 99 | driver-api/index |
24755a55 | 100 | core-api/index |
4c68060b | 101 | locking/index |
df1b7ce7 MCC |
102 | accounting/index |
103 | block/index | |
113094f7 | 104 | cdrom/index |
12bd112b | 105 | cpu-freq/index |
113094f7 MCC |
106 | fb/index |
107 | fpga/index | |
df1b7ce7 | 108 | hid/index |
ccf988b6 | 109 | i2c/index |
df1b7ce7 | 110 | iio/index |
5a5e045b | 111 | isdn/index |
a3a400da | 112 | infiniband/index |
09fdc957 | 113 | leds/index |
113094f7 | 114 | netlabel/index |
05e0f3b9 | 115 | networking/index |
113094f7 | 116 | pcmcia/index |
08a69058 | 117 | power/index |
113094f7 MCC |
118 | target/index |
119 | timers/index | |
9cdd273e | 120 | spi/index |
e9bb6275 | 121 | w1/index |
113094f7 | 122 | watchdog/index |
03d36521 | 123 | virt/index |
aeb899af | 124 | input/index |
7ebd8b66 | 125 | hwmon/index |
cb597fce | 126 | gpu/index |
799a545b | 127 | security/index |
8551914a | 128 | sound/index |
3b72c814 | 129 | crypto/index |
90f9f118 | 130 | filesystems/index |
82381918 | 131 | vm/index |
3209570d | 132 | bpf/index |
ecefae6d | 133 | usb/index |
c42eaffa | 134 | PCI/index |
31df2fd5 | 135 | scsi/index |
5591a307 | 136 | misc-devices/index |
c92992fc | 137 | scheduler/index |
9435dc3b | 138 | mhi/index |
0580565d | 139 | peci/index |
22cba31b | 140 | |
ffedeeb7 JS |
141 | Architecture-agnostic documentation |
142 | ----------------------------------- | |
143 | ||
144 | .. toctree:: | |
145 | :maxdepth: 2 | |
146 | ||
147 | asm-annotations | |
148 | ||
bffac837 MCC |
149 | Architecture-specific documentation |
150 | ----------------------------------- | |
151 | ||
bffac837 MCC |
152 | .. toctree:: |
153 | :maxdepth: 2 | |
154 | ||
3eca1cfb JN |
155 | arch |
156 | ||
bffac837 | 157 | |
8e2a46a4 MCC |
158 | Other documentation |
159 | ------------------- | |
160 | ||
161 | There are several unsorted documents that don't seem to fit on other parts | |
162 | of the documentation body, or may require some adjustments and/or conversion | |
163 | to ReStructured Text format, or are simply too old. | |
164 | ||
165 | .. toctree:: | |
166 | :maxdepth: 2 | |
167 | ||
941518d6 | 168 | tools/index |
8e2a46a4 MCC |
169 | staging/index |
170 | ||
171 | ||
85c32d9c FV |
172 | Translations |
173 | ------------ | |
2069889f AD |
174 | |
175 | .. toctree:: | |
85c32d9c | 176 | :maxdepth: 2 |
f0127338 | 177 | |
85c32d9c | 178 | translations/index |
f0127338 | 179 | |
22cba31b JN |
180 | Indices and tables |
181 | ================== | |
182 | ||
183 | * :ref:`genindex` |