index.rst 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. .. The Linux Kernel documentation master file, created by
  2. sphinx-quickstart on Fri Feb 12 13:51:46 2016.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. The Linux Kernel documentation
  6. ==============================
  7. This is the top level of the kernel's documentation tree. Kernel
  8. documentation, like the kernel itself, is very much a work in progress;
  9. that is especially true as we work to integrate our many scattered
  10. documents into a coherent whole. Please note that improvements to the
  11. documentation are welcome; join the linux-doc list at vger.kernel.org if
  12. you want to help out.
  13. Licensing documentation
  14. -----------------------
  15. The following describes the license of the Linux kernel source code
  16. (GPLv2), how to properly mark the license of individual files in the source
  17. tree, as well as links to the full license text.
  18. .. toctree::
  19. :maxdepth: 2
  20. process/license-rules.rst
  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. Application-developer documentation
  29. -----------------------------------
  30. The user-space API manual gathers together documents describing aspects of
  31. the kernel interface as seen by application developers.
  32. .. toctree::
  33. :maxdepth: 2
  34. userspace-api/index
  35. Introduction to kernel development
  36. ----------------------------------
  37. These manuals contain overall information about how to develop the kernel.
  38. The kernel community is quite large, with thousands of developers
  39. contributing over the course of a year. As with any large community,
  40. knowing how things are done will make the process of getting your changes
  41. merged much easier.
  42. .. toctree::
  43. :maxdepth: 2
  44. process/index
  45. dev-tools/index
  46. doc-guide/index
  47. kernel-hacking/index
  48. trace/index
  49. maintainer/index
  50. Kernel API documentation
  51. ------------------------
  52. These books get into the details of how specific kernel subsystems work
  53. from the point of view of a kernel developer. Much of the information here
  54. is taken directly from the kernel source, with supplemental material added
  55. as needed (or at least as we managed to add it — probably *not* all that is
  56. needed).
  57. .. toctree::
  58. :maxdepth: 2
  59. driver-api/index
  60. core-api/index
  61. media/index
  62. networking/index
  63. input/index
  64. gpu/index
  65. security/index
  66. sound/index
  67. crypto/index
  68. filesystems/index
  69. vm/index
  70. Architecture-specific documentation
  71. -----------------------------------
  72. These books provide programming details about architecture-specific
  73. implementation.
  74. .. toctree::
  75. :maxdepth: 2
  76. sh/index
  77. Filesystem Documentation
  78. ------------------------
  79. The documentation in this section are provided by specific filesystem
  80. subprojects.
  81. .. toctree::
  82. :maxdepth: 2
  83. filesystems/ext4/index
  84. Korean translations
  85. -------------------
  86. .. toctree::
  87. :maxdepth: 1
  88. translations/ko_KR/index
  89. Chinese translations
  90. --------------------
  91. .. toctree::
  92. :maxdepth: 1
  93. translations/zh_CN/index
  94. Japanese translations
  95. ---------------------
  96. .. toctree::
  97. :maxdepth: 1
  98. translations/ja_JP/index
  99. Indices and tables
  100. ==================
  101. * :ref:`genindex`