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