hc
2024-10-12 a5969cabbb4660eab42b6ef0412cbbd1200cf14d
kernel/Documentation/core-api/index.rst
....@@ -8,29 +8,92 @@
88 Core utilities
99 ==============
1010
11
+This section has general and "core core" documentation. The first is a
12
+massive grab-bag of kerneldoc info left over from the docbook days; it
13
+should really be broken up someday when somebody finds the energy to do
14
+it.
15
+
1116 .. toctree::
1217 :maxdepth: 1
1318
1419 kernel-api
15
- assoc_array
16
- atomic_ops
17
- cachetlb
18
- refcount-vs-atomic
19
- cpu_hotplug
20
- idr
21
- local_ops
2220 workqueue
23
- genericirq
24
- flexible-arrays
25
- librs
26
- genalloc
27
- errseq
21
+ printk-basics
2822 printk-formats
23
+ symbol-namespaces
24
+
25
+Data structures and low-level utilities
26
+=======================================
27
+
28
+Library 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
2938 circular-buffers
30
- mm-api
31
- gfp_mask-from-fs-io
39
+ rbtree
40
+ generic-radix-tree
41
+ packing
42
+ bus-virt-phys-mapping
43
+ this_cpu_ops
3244 timekeeping
45
+ errseq
46
+
47
+Concurrency primitives
48
+======================
49
+
50
+How Linux keeps everything from happening at the same time. See
51
+:doc:`/locking/index` for more related documentation.
52
+
53
+.. toctree::
54
+ :maxdepth: 1
55
+
56
+ atomic_ops
57
+ refcount-vs-atomic
58
+ irq/index
59
+ local_ops
60
+ padata
61
+ ../RCU/index
62
+
63
+Low-level hardware management
64
+=============================
65
+
66
+Cache management, managing CPU hotplug, etc.
67
+
68
+.. toctree::
69
+ :maxdepth: 1
70
+
71
+ cachetlb
72
+ cpu_hotplug
73
+ memory-hotplug
74
+ genericirq
75
+ protection-keys
76
+
77
+Memory management
78
+=================
79
+
80
+How to allocate and use memory in the kernel. Note that there is a lot
81
+more memory-management documentation in :doc:`/vm/index`.
82
+
83
+.. toctree::
84
+ :maxdepth: 1
85
+
86
+ memory-allocation
87
+ unaligned-memory-access
88
+ dma-api
89
+ dma-api-howto
90
+ dma-attributes
91
+ dma-isa-lpc
92
+ mm-api
93
+ genalloc
94
+ pin_user_pages
3395 boot-time-mm
96
+ gfp_mask-from-fs-io
3497
3598 Interfaces for kernel debugging
3699 ===============================
....@@ -40,8 +103,19 @@
40103
41104 debug-objects
42105 tracepoint
106
+ debugging-via-ohci1394
43107
44
-.. only:: subproject
108
+Everything else
109
+===============
110
+
111
+Documents that don't fit elsewhere or which have yet to be categorized.
112
+
113
+.. toctree::
114
+ :maxdepth: 1
115
+
116
+ librs
117
+
118
+.. only:: subproject and html
45119
46120 Indices
47121 =======