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