index.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  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. Data structures and low-level utilities
  23. =======================================
  24. Library functionality that is used throughout the kernel.
  25. .. toctree::
  26. :maxdepth: 1
  27. kobject
  28. kref
  29. assoc_array
  30. xarray
  31. maple_tree
  32. idr
  33. circular-buffers
  34. rbtree
  35. generic-radix-tree
  36. packing
  37. this_cpu_ops
  38. timekeeping
  39. errseq
  40. wrappers/atomic_t
  41. wrappers/atomic_bitops
  42. Low level entry and exit
  43. ========================
  44. .. toctree::
  45. :maxdepth: 1
  46. entry
  47. Concurrency primitives
  48. ======================
  49. How Linux keeps everything from happening at the same time. See
  50. Documentation/locking/index.rst for more related documentation.
  51. .. toctree::
  52. :maxdepth: 1
  53. refcount-vs-atomic
  54. irq/index
  55. local_ops
  56. padata
  57. ../RCU/index
  58. wrappers/memory-barriers.rst
  59. Low-level hardware management
  60. =============================
  61. Cache management, managing CPU hotplug, etc.
  62. .. toctree::
  63. :maxdepth: 1
  64. cachetlb
  65. cpu_hotplug
  66. memory-hotplug
  67. genericirq
  68. protection-keys
  69. Memory management
  70. =================
  71. How to allocate and use memory in the kernel. Note that there is a lot
  72. more memory-management documentation in Documentation/mm/index.rst.
  73. .. toctree::
  74. :maxdepth: 1
  75. memory-allocation
  76. unaligned-memory-access
  77. dma-api
  78. dma-api-howto
  79. dma-attributes
  80. dma-isa-lpc
  81. mm-api
  82. genalloc
  83. pin_user_pages
  84. boot-time-mm
  85. gfp_mask-from-fs-io
  86. Interfaces for kernel debugging
  87. ===============================
  88. .. toctree::
  89. :maxdepth: 1
  90. debug-objects
  91. tracepoint
  92. debugging-via-ohci1394
  93. Everything else
  94. ===============
  95. Documents that don't fit elsewhere or which have yet to be categorized.
  96. .. toctree::
  97. :maxdepth: 1
  98. librs
  99. .. only:: subproject and html
  100. Indices
  101. =======
  102. * :ref:`genindex`