index.rst 2.1 KB

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