1.. SPDX-License-Identifier: GPL-2.0 2 3 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 9.. _linux_doc: 10 11The Linux Kernel documentation 12============================== 13 14This is the top level of the kernel's documentation tree. Kernel 15documentation, like the kernel itself, is very much a work in progress; 16that is especially true as we work to integrate our many scattered 17documents into a coherent whole. Please note that improvements to the 18documentation are welcome; join the linux-doc list at vger.kernel.org if 19you want to help out. 20 21Licensing documentation 22----------------------- 23 24The following describes the license of the Linux kernel source code 25(GPLv2), how to properly mark the license of individual files in the source 26tree, as well as links to the full license text. 27 28* :ref:`kernel_licensing` 29 30User-oriented documentation 31--------------------------- 32 33The following manuals are written for *users* of the kernel — those who are 34trying to get it to work optimally on a given system. 35 36.. toctree:: 37 :maxdepth: 2 38 39 admin-guide/index 40 kbuild/index 41 42Firmware-related documentation 43------------------------------ 44The following holds information on the kernel's expectations regarding the 45platform firmwares. 46 47.. toctree:: 48 :maxdepth: 2 49 50 firmware-guide/index 51 devicetree/index 52 53Application-developer documentation 54----------------------------------- 55 56The user-space API manual gathers together documents describing aspects of 57the kernel interface as seen by application developers. 58 59.. toctree:: 60 :maxdepth: 2 61 62 userspace-api/index 63 64 65Introduction to kernel development 66---------------------------------- 67 68These manuals contain overall information about how to develop the kernel. 69The kernel community is quite large, with thousands of developers 70contributing over the course of a year. As with any large community, 71knowing how things are done will make the process of getting your changes 72merged much easier. 73 74.. toctree:: 75 :maxdepth: 2 76 77 process/index 78 dev-tools/index 79 doc-guide/index 80 kernel-hacking/index 81 trace/index 82 maintainer/index 83 fault-injection/index 84 livepatch/index 85 86 87Kernel API documentation 88------------------------ 89 90These books get into the details of how specific kernel subsystems work 91from the point of view of a kernel developer. Much of the information here 92is taken directly from the kernel source, with supplemental material added 93as needed (or at least as we managed to add it — probably *not* all that is 94needed). 95 96.. toctree:: 97 :maxdepth: 2 98 99 driver-api/index 100 core-api/index 101 locking/index 102 accounting/index 103 block/index 104 cdrom/index 105 cpu-freq/index 106 ide/index 107 fb/index 108 fpga/index 109 hid/index 110 i2c/index 111 iio/index 112 isdn/index 113 infiniband/index 114 leds/index 115 media/index 116 netlabel/index 117 networking/index 118 pcmcia/index 119 power/index 120 target/index 121 timers/index 122 spi/index 123 w1/index 124 watchdog/index 125 virt/index 126 input/index 127 hwmon/index 128 gpu/index 129 security/index 130 sound/index 131 crypto/index 132 filesystems/index 133 vm/index 134 bpf/index 135 usb/index 136 PCI/index 137 scsi/index 138 misc-devices/index 139 scheduler/index 140 mhi/index 141 142Architecture-agnostic documentation 143----------------------------------- 144 145.. toctree:: 146 :maxdepth: 2 147 148 asm-annotations 149 150Architecture-specific documentation 151----------------------------------- 152 153These books provide programming details about architecture-specific 154implementation. 155 156.. toctree:: 157 :maxdepth: 2 158 159 arm/index 160 arm64/index 161 ia64/index 162 m68k/index 163 mips/index 164 nios2/nios2 165 openrisc/index 166 parisc/index 167 powerpc/index 168 riscv/index 169 s390/index 170 sh/index 171 sparc/index 172 x86/index 173 xtensa/index 174 175Filesystem Documentation 176------------------------ 177 178The documentation in this section are provided by specific filesystem 179subprojects. 180 181.. toctree:: 182 :maxdepth: 2 183 184 filesystems/ext4/index 185 186Translations 187------------ 188 189.. toctree:: 190 :maxdepth: 2 191 192 translations/index 193 194Indices and tables 195================== 196 197* :ref:`genindex` 198