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