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 fb/index 107 fpga/index 108 hid/index 109 i2c/index 110 iio/index 111 isdn/index 112 infiniband/index 113 leds/index 114 netlabel/index 115 networking/index 116 pcmcia/index 117 power/index 118 target/index 119 timers/index 120 spi/index 121 w1/index 122 watchdog/index 123 virt/index 124 input/index 125 hwmon/index 126 gpu/index 127 security/index 128 sound/index 129 crypto/index 130 filesystems/index 131 mm/index 132 bpf/index 133 usb/index 134 PCI/index 135 scsi/index 136 misc-devices/index 137 scheduler/index 138 mhi/index 139 peci/index 140 141Architecture-agnostic documentation 142----------------------------------- 143 144.. toctree:: 145 :maxdepth: 2 146 147 asm-annotations 148 149Architecture-specific documentation 150----------------------------------- 151 152.. toctree:: 153 :maxdepth: 2 154 155 arch 156 157 158Other documentation 159------------------- 160 161There are several unsorted documents that don't seem to fit on other parts 162of the documentation body, or may require some adjustments and/or conversion 163to ReStructured Text format, or are simply too old. 164 165.. toctree:: 166 :maxdepth: 2 167 168 tools/index 169 staging/index 170 171 172Translations 173------------ 174 175.. toctree:: 176 :maxdepth: 2 177 178 translations/index 179 180Indices and tables 181================== 182 183* :ref:`genindex` 184