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 ioctl/index 61 62 63Introduction to kernel development 64---------------------------------- 65 66These manuals contain overall information about how to develop the kernel. 67The kernel community is quite large, with thousands of developers 68contributing over the course of a year. As with any large community, 69knowing how things are done will make the process of getting your changes 70merged much easier. 71 72.. toctree:: 73 :maxdepth: 2 74 75 process/index 76 dev-tools/index 77 doc-guide/index 78 kernel-hacking/index 79 trace/index 80 maintainer/index 81 fault-injection/index 82 livepatch/index 83 84 85Kernel API documentation 86------------------------ 87 88These books get into the details of how specific kernel subsystems work 89from the point of view of a kernel developer. Much of the information here 90is taken directly from the kernel source, with supplemental material added 91as needed (or at least as we managed to add it — probably *not* all that is 92needed). 93 94.. toctree:: 95 :maxdepth: 2 96 97 driver-api/index 98 core-api/index 99 locking/index 100 accounting/index 101 block/index 102 cdrom/index 103 ide/index 104 fb/index 105 fpga/index 106 hid/index 107 iio/index 108 infiniband/index 109 leds/index 110 media/index 111 netlabel/index 112 networking/index 113 pcmcia/index 114 target/index 115 timers/index 116 watchdog/index 117 input/index 118 hwmon/index 119 gpu/index 120 security/index 121 sound/index 122 crypto/index 123 filesystems/index 124 vm/index 125 bpf/index 126 usb/index 127 PCI/index 128 misc-devices/index 129 mic/index 130 scheduler/index 131 132Architecture-specific documentation 133----------------------------------- 134 135These books provide programming details about architecture-specific 136implementation. 137 138.. toctree:: 139 :maxdepth: 2 140 141 sh/index 142 arm/index 143 arm64/index 144 ia64/index 145 m68k/index 146 riscv/index 147 s390/index 148 sh/index 149 sparc/index 150 x86/index 151 xtensa/index 152 153Filesystem Documentation 154------------------------ 155 156The documentation in this section are provided by specific filesystem 157subprojects. 158 159.. toctree:: 160 :maxdepth: 2 161 162 filesystems/ext4/index 163 164Translations 165------------ 166 167.. toctree:: 168 :maxdepth: 2 169 170 translations/index 171 172Indices and tables 173================== 174 175* :ref:`genindex` 176