1*4882a593Smuzhiyun.. SPDX-License-Identifier: GPL-2.0 2*4882a593Smuzhiyun 3*4882a593Smuzhiyun 4*4882a593Smuzhiyun.. The Linux Kernel documentation master file, created by 5*4882a593Smuzhiyun sphinx-quickstart on Fri Feb 12 13:51:46 2016. 6*4882a593Smuzhiyun You can adapt this file completely to your liking, but it should at least 7*4882a593Smuzhiyun contain the root `toctree` directive. 8*4882a593Smuzhiyun 9*4882a593Smuzhiyun.. _linux_doc: 10*4882a593Smuzhiyun 11*4882a593SmuzhiyunThe Linux Kernel documentation 12*4882a593Smuzhiyun============================== 13*4882a593Smuzhiyun 14*4882a593SmuzhiyunThis is the top level of the kernel's documentation tree. Kernel 15*4882a593Smuzhiyundocumentation, like the kernel itself, is very much a work in progress; 16*4882a593Smuzhiyunthat is especially true as we work to integrate our many scattered 17*4882a593Smuzhiyundocuments into a coherent whole. Please note that improvements to the 18*4882a593Smuzhiyundocumentation are welcome; join the linux-doc list at vger.kernel.org if 19*4882a593Smuzhiyunyou want to help out. 20*4882a593Smuzhiyun 21*4882a593SmuzhiyunLicensing documentation 22*4882a593Smuzhiyun----------------------- 23*4882a593Smuzhiyun 24*4882a593SmuzhiyunThe following describes the license of the Linux kernel source code 25*4882a593Smuzhiyun(GPLv2), how to properly mark the license of individual files in the source 26*4882a593Smuzhiyuntree, as well as links to the full license text. 27*4882a593Smuzhiyun 28*4882a593Smuzhiyun* :ref:`kernel_licensing` 29*4882a593Smuzhiyun 30*4882a593SmuzhiyunUser-oriented documentation 31*4882a593Smuzhiyun--------------------------- 32*4882a593Smuzhiyun 33*4882a593SmuzhiyunThe following manuals are written for *users* of the kernel — those who are 34*4882a593Smuzhiyuntrying to get it to work optimally on a given system. 35*4882a593Smuzhiyun 36*4882a593Smuzhiyun.. toctree:: 37*4882a593Smuzhiyun :maxdepth: 2 38*4882a593Smuzhiyun 39*4882a593Smuzhiyun admin-guide/index 40*4882a593Smuzhiyun kbuild/index 41*4882a593Smuzhiyun 42*4882a593SmuzhiyunFirmware-related documentation 43*4882a593Smuzhiyun------------------------------ 44*4882a593SmuzhiyunThe following holds information on the kernel's expectations regarding the 45*4882a593Smuzhiyunplatform firmwares. 46*4882a593Smuzhiyun 47*4882a593Smuzhiyun.. toctree:: 48*4882a593Smuzhiyun :maxdepth: 2 49*4882a593Smuzhiyun 50*4882a593Smuzhiyun firmware-guide/index 51*4882a593Smuzhiyun devicetree/index 52*4882a593Smuzhiyun 53*4882a593SmuzhiyunApplication-developer documentation 54*4882a593Smuzhiyun----------------------------------- 55*4882a593Smuzhiyun 56*4882a593SmuzhiyunThe user-space API manual gathers together documents describing aspects of 57*4882a593Smuzhiyunthe kernel interface as seen by application developers. 58*4882a593Smuzhiyun 59*4882a593Smuzhiyun.. toctree:: 60*4882a593Smuzhiyun :maxdepth: 2 61*4882a593Smuzhiyun 62*4882a593Smuzhiyun userspace-api/index 63*4882a593Smuzhiyun 64*4882a593Smuzhiyun 65*4882a593SmuzhiyunIntroduction to kernel development 66*4882a593Smuzhiyun---------------------------------- 67*4882a593Smuzhiyun 68*4882a593SmuzhiyunThese manuals contain overall information about how to develop the kernel. 69*4882a593SmuzhiyunThe kernel community is quite large, with thousands of developers 70*4882a593Smuzhiyuncontributing over the course of a year. As with any large community, 71*4882a593Smuzhiyunknowing how things are done will make the process of getting your changes 72*4882a593Smuzhiyunmerged much easier. 73*4882a593Smuzhiyun 74*4882a593Smuzhiyun.. toctree:: 75*4882a593Smuzhiyun :maxdepth: 2 76*4882a593Smuzhiyun 77*4882a593Smuzhiyun process/index 78*4882a593Smuzhiyun dev-tools/index 79*4882a593Smuzhiyun doc-guide/index 80*4882a593Smuzhiyun kernel-hacking/index 81*4882a593Smuzhiyun trace/index 82*4882a593Smuzhiyun maintainer/index 83*4882a593Smuzhiyun fault-injection/index 84*4882a593Smuzhiyun livepatch/index 85*4882a593Smuzhiyun 86*4882a593Smuzhiyun 87*4882a593SmuzhiyunKernel API documentation 88*4882a593Smuzhiyun------------------------ 89*4882a593Smuzhiyun 90*4882a593SmuzhiyunThese books get into the details of how specific kernel subsystems work 91*4882a593Smuzhiyunfrom the point of view of a kernel developer. Much of the information here 92*4882a593Smuzhiyunis taken directly from the kernel source, with supplemental material added 93*4882a593Smuzhiyunas needed (or at least as we managed to add it — probably *not* all that is 94*4882a593Smuzhiyunneeded). 95*4882a593Smuzhiyun 96*4882a593Smuzhiyun.. toctree:: 97*4882a593Smuzhiyun :maxdepth: 2 98*4882a593Smuzhiyun 99*4882a593Smuzhiyun driver-api/index 100*4882a593Smuzhiyun core-api/index 101*4882a593Smuzhiyun locking/index 102*4882a593Smuzhiyun accounting/index 103*4882a593Smuzhiyun block/index 104*4882a593Smuzhiyun cdrom/index 105*4882a593Smuzhiyun cpu-freq/index 106*4882a593Smuzhiyun ide/index 107*4882a593Smuzhiyun fb/index 108*4882a593Smuzhiyun fpga/index 109*4882a593Smuzhiyun hid/index 110*4882a593Smuzhiyun i2c/index 111*4882a593Smuzhiyun iio/index 112*4882a593Smuzhiyun isdn/index 113*4882a593Smuzhiyun infiniband/index 114*4882a593Smuzhiyun leds/index 115*4882a593Smuzhiyun netlabel/index 116*4882a593Smuzhiyun networking/index 117*4882a593Smuzhiyun pcmcia/index 118*4882a593Smuzhiyun power/index 119*4882a593Smuzhiyun target/index 120*4882a593Smuzhiyun timers/index 121*4882a593Smuzhiyun spi/index 122*4882a593Smuzhiyun w1/index 123*4882a593Smuzhiyun watchdog/index 124*4882a593Smuzhiyun virt/index 125*4882a593Smuzhiyun input/index 126*4882a593Smuzhiyun hwmon/index 127*4882a593Smuzhiyun gpu/index 128*4882a593Smuzhiyun security/index 129*4882a593Smuzhiyun sound/index 130*4882a593Smuzhiyun crypto/index 131*4882a593Smuzhiyun filesystems/index 132*4882a593Smuzhiyun vm/index 133*4882a593Smuzhiyun bpf/index 134*4882a593Smuzhiyun usb/index 135*4882a593Smuzhiyun PCI/index 136*4882a593Smuzhiyun scsi/index 137*4882a593Smuzhiyun misc-devices/index 138*4882a593Smuzhiyun scheduler/index 139*4882a593Smuzhiyun mhi/index 140*4882a593Smuzhiyun 141*4882a593SmuzhiyunArchitecture-agnostic documentation 142*4882a593Smuzhiyun----------------------------------- 143*4882a593Smuzhiyun 144*4882a593Smuzhiyun.. toctree:: 145*4882a593Smuzhiyun :maxdepth: 2 146*4882a593Smuzhiyun 147*4882a593Smuzhiyun asm-annotations 148*4882a593Smuzhiyun 149*4882a593SmuzhiyunArchitecture-specific documentation 150*4882a593Smuzhiyun----------------------------------- 151*4882a593Smuzhiyun 152*4882a593SmuzhiyunThese books provide programming details about architecture-specific 153*4882a593Smuzhiyunimplementation. 154*4882a593Smuzhiyun 155*4882a593Smuzhiyun.. toctree:: 156*4882a593Smuzhiyun :maxdepth: 2 157*4882a593Smuzhiyun 158*4882a593Smuzhiyun arm/index 159*4882a593Smuzhiyun arm64/index 160*4882a593Smuzhiyun ia64/index 161*4882a593Smuzhiyun m68k/index 162*4882a593Smuzhiyun mips/index 163*4882a593Smuzhiyun nios2/nios2 164*4882a593Smuzhiyun openrisc/index 165*4882a593Smuzhiyun parisc/index 166*4882a593Smuzhiyun powerpc/index 167*4882a593Smuzhiyun riscv/index 168*4882a593Smuzhiyun s390/index 169*4882a593Smuzhiyun sh/index 170*4882a593Smuzhiyun sparc/index 171*4882a593Smuzhiyun x86/index 172*4882a593Smuzhiyun xtensa/index 173*4882a593Smuzhiyun 174*4882a593SmuzhiyunFilesystem Documentation 175*4882a593Smuzhiyun------------------------ 176*4882a593Smuzhiyun 177*4882a593SmuzhiyunThe documentation in this section are provided by specific filesystem 178*4882a593Smuzhiyunsubprojects. 179*4882a593Smuzhiyun 180*4882a593Smuzhiyun.. toctree:: 181*4882a593Smuzhiyun :maxdepth: 2 182*4882a593Smuzhiyun 183*4882a593Smuzhiyun filesystems/ext4/index 184*4882a593Smuzhiyun 185*4882a593SmuzhiyunOther documentation 186*4882a593Smuzhiyun------------------- 187*4882a593Smuzhiyun 188*4882a593SmuzhiyunThere are several unsorted documents that don't seem to fit on other parts 189*4882a593Smuzhiyunof the documentation body, or may require some adjustments and/or conversion 190*4882a593Smuzhiyunto ReStructured Text format, or are simply too old. 191*4882a593Smuzhiyun 192*4882a593Smuzhiyun.. toctree:: 193*4882a593Smuzhiyun :maxdepth: 2 194*4882a593Smuzhiyun 195*4882a593Smuzhiyun staging/index 196*4882a593Smuzhiyun watch_queue 197*4882a593Smuzhiyun 198*4882a593Smuzhiyun 199*4882a593SmuzhiyunTranslations 200*4882a593Smuzhiyun------------ 201*4882a593Smuzhiyun 202*4882a593Smuzhiyun.. toctree:: 203*4882a593Smuzhiyun :maxdepth: 2 204*4882a593Smuzhiyun 205*4882a593Smuzhiyun translations/index 206*4882a593Smuzhiyun 207*4882a593SmuzhiyunIndices and tables 208*4882a593Smuzhiyun================== 209*4882a593Smuzhiyun 210*4882a593Smuzhiyun* :ref:`genindex` 211