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