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 netlabel/index 113 networking/index 114 pcmcia/index 115 power/index 116 target/index 117 timers/index 118 spi/index 119 w1/index 120 watchdog/index 121 virt/index 122 input/index 123 hwmon/index 124 gpu/index 125 security/index 126 sound/index 127 crypto/index 128 filesystems/index 129 vm/index 130 bpf/index 131 usb/index 132 PCI/index 133 scsi/index 134 misc-devices/index 135 scheduler/index 136 mhi/index 137 138Architecture-agnostic documentation 139----------------------------------- 140 141.. toctree:: 142 :maxdepth: 2 143 144 asm-annotations 145 146Architecture-specific documentation 147----------------------------------- 148 149These books provide programming details about architecture-specific 150implementation. 151 152.. toctree:: 153 :maxdepth: 2 154 155 arm/index 156 arm64/index 157 ia64/index 158 m68k/index 159 mips/index 160 nios2/nios2 161 openrisc/index 162 parisc/index 163 powerpc/index 164 riscv/index 165 s390/index 166 sh/index 167 sparc/index 168 x86/index 169 xtensa/index 170 171Filesystem Documentation 172------------------------ 173 174The documentation in this section are provided by specific filesystem 175subprojects. 176 177.. toctree:: 178 :maxdepth: 2 179 180 filesystems/ext4/index 181 182Translations 183------------ 184 185.. toctree:: 186 :maxdepth: 2 187 188 translations/index 189 190Indices and tables 191================== 192 193* :ref:`genindex` 194