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