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