index.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. ======================
  2. Core API Documentation
  3. ======================
  4. This is the beginning of a manual for core kernel APIs. The conversion
  5. (and writing!) of documents for this manual is much appreciated!
  6. Core utilities
  7. ==============
  8. This section has general and "core core" documentation. The first is a
  9. massive grab-bag of kerneldoc info left over from the docbook days; it
  10. should really be broken up someday when somebody finds the energy to do
  11. it.
  12. .. toctree::
  13. :maxdepth: 1
  14. kernel-api
  15. workqueue
  16. watch_queue
  17. printk-basics
  18. printk-formats
  19. printk-index
  20. symbol-namespaces
  21. asm-annotations
  22. real-time/index
  23. housekeeping.rst
  24. Data structures and low-level utilities
  25. =======================================
  26. Library functionality that is used throughout the kernel.
  27. .. toctree::
  28. :maxdepth: 1
  29. kobject
  30. kref
  31. cleanup
  32. assoc_array
  33. folio_queue
  34. xarray
  35. maple_tree
  36. idr
  37. circular-buffers
  38. rbtree
  39. generic-radix-tree
  40. packing
  41. this_cpu_ops
  42. timekeeping
  43. errseq
  44. wrappers/atomic_t
  45. wrappers/atomic_bitops
  46. floating-point
  47. union_find
  48. min_heap
  49. parser
  50. list
  51. Low level entry and exit
  52. ========================
  53. .. toctree::
  54. :maxdepth: 1
  55. entry
  56. Concurrency primitives
  57. ======================
  58. How Linux keeps everything from happening at the same time. See
  59. Documentation/locking/index.rst for more related documentation.
  60. .. toctree::
  61. :maxdepth: 1
  62. refcount-vs-atomic
  63. irq/index
  64. local_ops
  65. padata
  66. ../RCU/index
  67. wrappers/memory-barriers.rst
  68. Low-level hardware management
  69. =============================
  70. Cache management, managing CPU hotplug, etc.
  71. .. toctree::
  72. :maxdepth: 1
  73. cachetlb
  74. cpu_hotplug
  75. memory-hotplug
  76. genericirq
  77. protection-keys
  78. Memory management
  79. =================
  80. How to allocate and use memory in the kernel. Note that there is a lot
  81. more memory-management documentation in Documentation/mm/index.rst.
  82. .. toctree::
  83. :maxdepth: 1
  84. memory-allocation
  85. unaligned-memory-access
  86. dma-api
  87. dma-api-howto
  88. dma-attributes
  89. dma-isa-lpc
  90. swiotlb
  91. mm-api
  92. cgroup
  93. genalloc
  94. pin_user_pages
  95. boot-time-mm
  96. gfp_mask-from-fs-io
  97. kho/index
  98. Interfaces for kernel debugging
  99. ===============================
  100. .. toctree::
  101. :maxdepth: 1
  102. debug-objects
  103. tracepoint
  104. debugging-via-ohci1394
  105. Everything else
  106. ===============
  107. Documents that don't fit elsewhere or which have yet to be categorized.
  108. .. toctree::
  109. :maxdepth: 1
  110. librs
  111. liveupdate
  112. netlink