18c2ecf20Sopenharmony_ci.. SPDX-License-Identifier: GPL-2.0 28c2ecf20Sopenharmony_ci 38c2ecf20Sopenharmony_ci 48c2ecf20Sopenharmony_ci.. The Linux Kernel documentation master file, created by 58c2ecf20Sopenharmony_ci sphinx-quickstart on Fri Feb 12 13:51:46 2016. 68c2ecf20Sopenharmony_ci You can adapt this file completely to your liking, but it should at least 78c2ecf20Sopenharmony_ci contain the root `toctree` directive. 88c2ecf20Sopenharmony_ci 98c2ecf20Sopenharmony_ci.. _linux_doc: 108c2ecf20Sopenharmony_ci 118c2ecf20Sopenharmony_ciThe Linux Kernel documentation 128c2ecf20Sopenharmony_ci============================== 138c2ecf20Sopenharmony_ci 148c2ecf20Sopenharmony_ciThis is the top level of the kernel's documentation tree. Kernel 158c2ecf20Sopenharmony_cidocumentation, like the kernel itself, is very much a work in progress; 168c2ecf20Sopenharmony_cithat is especially true as we work to integrate our many scattered 178c2ecf20Sopenharmony_cidocuments into a coherent whole. Please note that improvements to the 188c2ecf20Sopenharmony_cidocumentation are welcome; join the linux-doc list at vger.kernel.org if 198c2ecf20Sopenharmony_ciyou want to help out. 208c2ecf20Sopenharmony_ci 218c2ecf20Sopenharmony_ciLicensing documentation 228c2ecf20Sopenharmony_ci----------------------- 238c2ecf20Sopenharmony_ci 248c2ecf20Sopenharmony_ciThe following describes the license of the Linux kernel source code 258c2ecf20Sopenharmony_ci(GPLv2), how to properly mark the license of individual files in the source 268c2ecf20Sopenharmony_citree, as well as links to the full license text. 278c2ecf20Sopenharmony_ci 288c2ecf20Sopenharmony_ci* :ref:`kernel_licensing` 298c2ecf20Sopenharmony_ci 308c2ecf20Sopenharmony_ciUser-oriented documentation 318c2ecf20Sopenharmony_ci--------------------------- 328c2ecf20Sopenharmony_ci 338c2ecf20Sopenharmony_ciThe following manuals are written for *users* of the kernel — those who are 348c2ecf20Sopenharmony_citrying to get it to work optimally on a given system. 358c2ecf20Sopenharmony_ci 368c2ecf20Sopenharmony_ci.. toctree:: 378c2ecf20Sopenharmony_ci :maxdepth: 2 388c2ecf20Sopenharmony_ci 398c2ecf20Sopenharmony_ci admin-guide/index 408c2ecf20Sopenharmony_ci kbuild/index 418c2ecf20Sopenharmony_ci 428c2ecf20Sopenharmony_ciFirmware-related documentation 438c2ecf20Sopenharmony_ci------------------------------ 448c2ecf20Sopenharmony_ciThe following holds information on the kernel's expectations regarding the 458c2ecf20Sopenharmony_ciplatform firmwares. 468c2ecf20Sopenharmony_ci 478c2ecf20Sopenharmony_ci.. toctree:: 488c2ecf20Sopenharmony_ci :maxdepth: 2 498c2ecf20Sopenharmony_ci 508c2ecf20Sopenharmony_ci firmware-guide/index 518c2ecf20Sopenharmony_ci devicetree/index 528c2ecf20Sopenharmony_ci 538c2ecf20Sopenharmony_ciApplication-developer documentation 548c2ecf20Sopenharmony_ci----------------------------------- 558c2ecf20Sopenharmony_ci 568c2ecf20Sopenharmony_ciThe user-space API manual gathers together documents describing aspects of 578c2ecf20Sopenharmony_cithe kernel interface as seen by application developers. 588c2ecf20Sopenharmony_ci 598c2ecf20Sopenharmony_ci.. toctree:: 608c2ecf20Sopenharmony_ci :maxdepth: 2 618c2ecf20Sopenharmony_ci 628c2ecf20Sopenharmony_ci userspace-api/index 638c2ecf20Sopenharmony_ci 648c2ecf20Sopenharmony_ci 658c2ecf20Sopenharmony_ciIntroduction to kernel development 668c2ecf20Sopenharmony_ci---------------------------------- 678c2ecf20Sopenharmony_ci 688c2ecf20Sopenharmony_ciThese manuals contain overall information about how to develop the kernel. 698c2ecf20Sopenharmony_ciThe kernel community is quite large, with thousands of developers 708c2ecf20Sopenharmony_cicontributing over the course of a year. As with any large community, 718c2ecf20Sopenharmony_ciknowing how things are done will make the process of getting your changes 728c2ecf20Sopenharmony_cimerged much easier. 738c2ecf20Sopenharmony_ci 748c2ecf20Sopenharmony_ci.. toctree:: 758c2ecf20Sopenharmony_ci :maxdepth: 2 768c2ecf20Sopenharmony_ci 778c2ecf20Sopenharmony_ci process/index 788c2ecf20Sopenharmony_ci dev-tools/index 798c2ecf20Sopenharmony_ci doc-guide/index 808c2ecf20Sopenharmony_ci kernel-hacking/index 818c2ecf20Sopenharmony_ci trace/index 828c2ecf20Sopenharmony_ci maintainer/index 838c2ecf20Sopenharmony_ci fault-injection/index 848c2ecf20Sopenharmony_ci livepatch/index 858c2ecf20Sopenharmony_ci 868c2ecf20Sopenharmony_ci 878c2ecf20Sopenharmony_ciKernel API documentation 888c2ecf20Sopenharmony_ci------------------------ 898c2ecf20Sopenharmony_ci 908c2ecf20Sopenharmony_ciThese books get into the details of how specific kernel subsystems work 918c2ecf20Sopenharmony_cifrom the point of view of a kernel developer. Much of the information here 928c2ecf20Sopenharmony_ciis taken directly from the kernel source, with supplemental material added 938c2ecf20Sopenharmony_cias needed (or at least as we managed to add it — probably *not* all that is 948c2ecf20Sopenharmony_cineeded). 958c2ecf20Sopenharmony_ci 968c2ecf20Sopenharmony_ci.. toctree:: 978c2ecf20Sopenharmony_ci :maxdepth: 2 988c2ecf20Sopenharmony_ci 998c2ecf20Sopenharmony_ci driver-api/index 1008c2ecf20Sopenharmony_ci core-api/index 1018c2ecf20Sopenharmony_ci locking/index 1028c2ecf20Sopenharmony_ci accounting/index 1038c2ecf20Sopenharmony_ci block/index 1048c2ecf20Sopenharmony_ci cdrom/index 1058c2ecf20Sopenharmony_ci cpu-freq/index 1068c2ecf20Sopenharmony_ci ide/index 1078c2ecf20Sopenharmony_ci fb/index 1088c2ecf20Sopenharmony_ci fpga/index 1098c2ecf20Sopenharmony_ci hid/index 1108c2ecf20Sopenharmony_ci i2c/index 1118c2ecf20Sopenharmony_ci iio/index 1128c2ecf20Sopenharmony_ci isdn/index 1138c2ecf20Sopenharmony_ci infiniband/index 1148c2ecf20Sopenharmony_ci leds/index 1158c2ecf20Sopenharmony_ci netlabel/index 1168c2ecf20Sopenharmony_ci networking/index 1178c2ecf20Sopenharmony_ci pcmcia/index 1188c2ecf20Sopenharmony_ci power/index 1198c2ecf20Sopenharmony_ci target/index 1208c2ecf20Sopenharmony_ci timers/index 1218c2ecf20Sopenharmony_ci spi/index 1228c2ecf20Sopenharmony_ci w1/index 1238c2ecf20Sopenharmony_ci watchdog/index 1248c2ecf20Sopenharmony_ci virt/index 1258c2ecf20Sopenharmony_ci input/index 1268c2ecf20Sopenharmony_ci hwmon/index 1278c2ecf20Sopenharmony_ci gpu/index 1288c2ecf20Sopenharmony_ci security/index 1298c2ecf20Sopenharmony_ci sound/index 1308c2ecf20Sopenharmony_ci crypto/index 1318c2ecf20Sopenharmony_ci filesystems/index 1328c2ecf20Sopenharmony_ci vm/index 1338c2ecf20Sopenharmony_ci bpf/index 1348c2ecf20Sopenharmony_ci usb/index 1358c2ecf20Sopenharmony_ci PCI/index 1368c2ecf20Sopenharmony_ci scsi/index 1378c2ecf20Sopenharmony_ci misc-devices/index 1388c2ecf20Sopenharmony_ci scheduler/index 1398c2ecf20Sopenharmony_ci mhi/index 1408c2ecf20Sopenharmony_ci 1418c2ecf20Sopenharmony_ciArchitecture-agnostic documentation 1428c2ecf20Sopenharmony_ci----------------------------------- 1438c2ecf20Sopenharmony_ci 1448c2ecf20Sopenharmony_ci.. toctree:: 1458c2ecf20Sopenharmony_ci :maxdepth: 2 1468c2ecf20Sopenharmony_ci 1478c2ecf20Sopenharmony_ci asm-annotations 1488c2ecf20Sopenharmony_ci 1498c2ecf20Sopenharmony_ciArchitecture-specific documentation 1508c2ecf20Sopenharmony_ci----------------------------------- 1518c2ecf20Sopenharmony_ci 1528c2ecf20Sopenharmony_ciThese books provide programming details about architecture-specific 1538c2ecf20Sopenharmony_ciimplementation. 1548c2ecf20Sopenharmony_ci 1558c2ecf20Sopenharmony_ci.. toctree:: 1568c2ecf20Sopenharmony_ci :maxdepth: 2 1578c2ecf20Sopenharmony_ci 1588c2ecf20Sopenharmony_ci arm/index 1598c2ecf20Sopenharmony_ci arm64/index 1608c2ecf20Sopenharmony_ci ia64/index 1618c2ecf20Sopenharmony_ci m68k/index 1628c2ecf20Sopenharmony_ci mips/index 1638c2ecf20Sopenharmony_ci nios2/nios2 1648c2ecf20Sopenharmony_ci openrisc/index 1658c2ecf20Sopenharmony_ci parisc/index 1668c2ecf20Sopenharmony_ci powerpc/index 1678c2ecf20Sopenharmony_ci riscv/index 1688c2ecf20Sopenharmony_ci s390/index 1698c2ecf20Sopenharmony_ci sh/index 1708c2ecf20Sopenharmony_ci sparc/index 1718c2ecf20Sopenharmony_ci x86/index 1728c2ecf20Sopenharmony_ci xtensa/index 1738c2ecf20Sopenharmony_ci 1748c2ecf20Sopenharmony_ciFilesystem Documentation 1758c2ecf20Sopenharmony_ci------------------------ 1768c2ecf20Sopenharmony_ci 1778c2ecf20Sopenharmony_ciThe documentation in this section are provided by specific filesystem 1788c2ecf20Sopenharmony_cisubprojects. 1798c2ecf20Sopenharmony_ci 1808c2ecf20Sopenharmony_ci.. toctree:: 1818c2ecf20Sopenharmony_ci :maxdepth: 2 1828c2ecf20Sopenharmony_ci 1838c2ecf20Sopenharmony_ci filesystems/ext4/index 1848c2ecf20Sopenharmony_ci 1858c2ecf20Sopenharmony_ciOther documentation 1868c2ecf20Sopenharmony_ci------------------- 1878c2ecf20Sopenharmony_ci 1888c2ecf20Sopenharmony_ciThere are several unsorted documents that don't seem to fit on other parts 1898c2ecf20Sopenharmony_ciof the documentation body, or may require some adjustments and/or conversion 1908c2ecf20Sopenharmony_cito ReStructured Text format, or are simply too old. 1918c2ecf20Sopenharmony_ci 1928c2ecf20Sopenharmony_ci.. toctree:: 1938c2ecf20Sopenharmony_ci :maxdepth: 2 1948c2ecf20Sopenharmony_ci 1958c2ecf20Sopenharmony_ci staging/index 1968c2ecf20Sopenharmony_ci watch_queue 1978c2ecf20Sopenharmony_ci 1988c2ecf20Sopenharmony_ci 1998c2ecf20Sopenharmony_ciTranslations 2008c2ecf20Sopenharmony_ci------------ 2018c2ecf20Sopenharmony_ci 2028c2ecf20Sopenharmony_ci.. toctree:: 2038c2ecf20Sopenharmony_ci :maxdepth: 2 2048c2ecf20Sopenharmony_ci 2058c2ecf20Sopenharmony_ci translations/index 2068c2ecf20Sopenharmony_ci 2078c2ecf20Sopenharmony_ciIndices and tables 2088c2ecf20Sopenharmony_ci================== 2098c2ecf20Sopenharmony_ci 2108c2ecf20Sopenharmony_ci* :ref:`genindex` 211