index.rst 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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. User-oriented documentation
  14. ---------------------------
  15. The following manuals are written for *users* of the kernel — those who are
  16. trying to get it to work optimally on a given system.
  17. .. toctree::
  18. :maxdepth: 2
  19. admin-guide/index
  20. Application-developer documentation
  21. -----------------------------------
  22. The user-space API manual gathers together documents describing aspects of
  23. the kernel interface as seen by application developers.
  24. .. toctree::
  25. :maxdepth: 2
  26. userspace-api/index
  27. Introduction to kernel development
  28. ----------------------------------
  29. These manuals contain overall information about how to develop the kernel.
  30. The kernel community is quite large, with thousands of developers
  31. contributing over the course of a year. As with any large community,
  32. knowing how things are done will make the process of getting your changes
  33. merged much easier.
  34. .. toctree::
  35. :maxdepth: 2
  36. process/index
  37. dev-tools/index
  38. doc-guide/index
  39. kernel-hacking/index
  40. Kernel API documentation
  41. ------------------------
  42. These books get into the details of how specific kernel subsystems work
  43. from the point of view of a kernel developer. Much of the information here
  44. is taken directly from the kernel source, with supplemental material added
  45. as needed (or at least as we managed to add it — probably *not* all that is
  46. needed).
  47. .. toctree::
  48. :maxdepth: 2
  49. driver-api/index
  50. core-api/index
  51. media/index
  52. networking/index
  53. input/index
  54. gpu/index
  55. security/index
  56. sound/index
  57. crypto/index
  58. filesystems/index
  59. Architecture-specific documentation
  60. -----------------------------------
  61. These books provide programming details about architecture-specific
  62. implementation.
  63. .. toctree::
  64. :maxdepth: 2
  65. sh/index
  66. Korean translations
  67. -------------------
  68. .. toctree::
  69. :maxdepth: 1
  70. translations/ko_KR/index
  71. Chinese translations
  72. --------------------
  73. .. toctree::
  74. :maxdepth: 1
  75. translations/zh_CN/index
  76. Japanese translations
  77. ---------------------
  78. .. toctree::
  79. :maxdepth: 1
  80. translations/ja_JP/index
  81. Indices and tables
  82. ==================
  83. * :ref:`genindex`