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