index.rst 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. .. SPDX-License-Identifier: GPL-2.0
  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. .. _linux_doc:
  7. The Linux Kernel documentation
  8. ==============================
  9. This is the top level of the kernel's documentation tree. Kernel
  10. documentation, like the kernel itself, is very much a work in progress;
  11. that is especially true as we work to integrate our many scattered
  12. documents into a coherent whole. Please note that improvements to the
  13. documentation are welcome; join the linux-doc list at vger.kernel.org if
  14. you want to help out.
  15. Licensing documentation
  16. -----------------------
  17. The following describes the license of the Linux kernel source code
  18. (GPLv2), how to properly mark the license of individual files in the source
  19. tree, as well as links to the full license text.
  20. * :ref:`kernel_licensing`
  21. User-oriented documentation
  22. ---------------------------
  23. The following manuals are written for *users* of the kernel — those who are
  24. trying to get it to work optimally on a given system.
  25. .. toctree::
  26. :maxdepth: 2
  27. admin-guide/index
  28. kbuild/index
  29. Firmware-related documentation
  30. ------------------------------
  31. The following holds information on the kernel's expectations regarding the
  32. platform firmwares.
  33. .. toctree::
  34. :maxdepth: 2
  35. firmware-guide/index
  36. devicetree/index
  37. Application-developer documentation
  38. -----------------------------------
  39. The user-space API manual gathers together documents describing aspects of
  40. the kernel interface as seen by application developers.
  41. .. toctree::
  42. :maxdepth: 2
  43. userspace-api/index
  44. Introduction to kernel development
  45. ----------------------------------
  46. These manuals contain overall information about how to develop the kernel.
  47. The kernel community is quite large, with thousands of developers
  48. contributing over the course of a year. As with any large community,
  49. knowing how things are done will make the process of getting your changes
  50. merged much easier.
  51. .. toctree::
  52. :maxdepth: 2
  53. process/index
  54. dev-tools/index
  55. doc-guide/index
  56. kernel-hacking/index
  57. trace/index
  58. maintainer/index
  59. fault-injection/index
  60. livepatch/index
  61. Kernel API documentation
  62. ------------------------
  63. These books get into the details of how specific kernel subsystems work
  64. from the point of view of a kernel developer. Much of the information here
  65. is taken directly from the kernel source, with supplemental material added
  66. as needed (or at least as we managed to add it — probably *not* all that is
  67. needed).
  68. .. toctree::
  69. :maxdepth: 2
  70. driver-api/index
  71. core-api/index
  72. locking/index
  73. accounting/index
  74. block/index
  75. cdrom/index
  76. cpu-freq/index
  77. ide/index
  78. fb/index
  79. fpga/index
  80. hid/index
  81. i2c/index
  82. iio/index
  83. isdn/index
  84. infiniband/index
  85. leds/index
  86. netlabel/index
  87. networking/index
  88. pcmcia/index
  89. power/index
  90. target/index
  91. timers/index
  92. spi/index
  93. w1/index
  94. watchdog/index
  95. virt/index
  96. input/index
  97. hwmon/index
  98. gpu/index
  99. security/index
  100. sound/index
  101. crypto/index
  102. filesystems/index
  103. vm/index
  104. bpf/index
  105. usb/index
  106. PCI/index
  107. scsi/index
  108. misc-devices/index
  109. scheduler/index
  110. mhi/index
  111. Architecture-agnostic documentation
  112. -----------------------------------
  113. .. toctree::
  114. :maxdepth: 2
  115. asm-annotations
  116. Architecture-specific documentation
  117. -----------------------------------
  118. These books provide programming details about architecture-specific
  119. implementation.
  120. .. toctree::
  121. :maxdepth: 2
  122. arm/index
  123. arm64/index
  124. ia64/index
  125. m68k/index
  126. mips/index
  127. nios2/nios2
  128. openrisc/index
  129. parisc/index
  130. powerpc/index
  131. riscv/index
  132. s390/index
  133. sh/index
  134. sparc/index
  135. x86/index
  136. xtensa/index
  137. Filesystem Documentation
  138. ------------------------
  139. The documentation in this section are provided by specific filesystem
  140. subprojects.
  141. .. toctree::
  142. :maxdepth: 2
  143. filesystems/ext4/index
  144. Other documentation
  145. -------------------
  146. There are several unsorted documents that don't seem to fit on other parts
  147. of the documentation body, or may require some adjustments and/or conversion
  148. to ReStructured Text format, or are simply too old.
  149. .. toctree::
  150. :maxdepth: 2
  151. staging/index
  152. watch_queue
  153. Translations
  154. ------------
  155. .. toctree::
  156. :maxdepth: 2
  157. translations/index
  158. Indices and tables
  159. ==================
  160. * :ref:`genindex`