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   timekeeping
43   errseq
44
45Concurrency primitives
46======================
47
48How Linux keeps everything from happening at the same time.  See
49:doc:`/locking/index` for more related documentation.
50
51.. toctree::
52   :maxdepth: 1
53
54   atomic_ops
55   refcount-vs-atomic
56   irq/index
57   local_ops
58   padata
59   ../RCU/index
60
61Low-level hardware management
62=============================
63
64Cache management, managing CPU hotplug, etc.
65
66.. toctree::
67   :maxdepth: 1
68
69   cachetlb
70   cpu_hotplug
71   memory-hotplug
72   genericirq
73   protection-keys
74
75Memory management
76=================
77
78How to allocate and use memory in the kernel.  Note that there is a lot
79more memory-management documentation in :doc:`/vm/index`.
80
81.. toctree::
82   :maxdepth: 1
83
84   memory-allocation
85   dma-api
86   dma-api-howto
87   dma-attributes
88   dma-isa-lpc
89   mm-api
90   genalloc
91   pin_user_pages
92   boot-time-mm
93   gfp_mask-from-fs-io
94
95Interfaces for kernel debugging
96===============================
97
98.. toctree::
99   :maxdepth: 1
100
101   debug-objects
102   tracepoint
103   debugging-via-ohci1394
104
105Everything else
106===============
107
108Documents that don't fit elsewhere or which have yet to be categorized.
109
110.. toctree::
111   :maxdepth: 1
112
113   librs
114
115.. only:: subproject and html
116
117   Indices
118   =======
119
120   * :ref:`genindex`
121