summaryrefslogtreecommitdiff
path: root/Documentation/core-api/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/core-api/index.rst')
-rw-r--r--Documentation/core-api/index.rst130
1 files changed, 113 insertions, 17 deletions
diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index 3adee82be311..5eb0fbbbc323 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -8,33 +8,116 @@ This is the beginning of a manual for core kernel APIs. The conversion
Core utilities
==============
+This section has general and "core core" documentation. The first is a
+massive grab-bag of kerneldoc info left over from the docbook days; it
+should really be broken up someday when somebody finds the energy to do
+it.
+
.. toctree::
:maxdepth: 1
kernel-api
+ workqueue
+ watch_queue
+ printk-basics
+ printk-formats
+ printk-index
+ symbol-namespaces
+ asm-annotations
+ real-time/index
+
+Data structures and low-level utilities
+=======================================
+
+Library functionality that is used throughout the kernel.
+
+.. toctree::
+ :maxdepth: 1
+
+ kobject
+ kref
+ cleanup
assoc_array
- atomic_ops
- cachetlb
- refcount-vs-atomic
- cpu_hotplug
+ folio_queue
+ xarray
+ maple_tree
idr
+ circular-buffers
+ rbtree
+ generic-radix-tree
+ packing
+ this_cpu_ops
+ timekeeping
+ errseq
+ wrappers/atomic_t
+ wrappers/atomic_bitops
+ floating-point
+ union_find
+ min_heap
+ parser
+ list
+
+Low level entry and exit
+========================
+
+.. toctree::
+ :maxdepth: 1
+
+ entry
+
+Concurrency primitives
+======================
+
+How Linux keeps everything from happening at the same time. See
+Documentation/locking/index.rst for more related documentation.
+
+.. toctree::
+ :maxdepth: 1
+
+ refcount-vs-atomic
+ irq/index
local_ops
- workqueue
+ padata
+ ../RCU/index
+ wrappers/memory-barriers.rst
+
+Low-level hardware management
+=============================
+
+Cache management, managing CPU hotplug, etc.
+
+.. toctree::
+ :maxdepth: 1
+
+ cachetlb
+ cpu_hotplug
+ memory-hotplug
genericirq
- xarray
- flexible-arrays
- librs
- genalloc
- errseq
- printk-formats
- circular-buffers
+ protection-keys
+
+Memory management
+=================
+
+How to allocate and use memory in the kernel. Note that there is a lot
+more memory-management documentation in Documentation/mm/index.rst.
+
+.. toctree::
+ :maxdepth: 1
+
memory-allocation
+ unaligned-memory-access
+ dma-api
+ dma-api-howto
+ dma-attributes
+ dma-isa-lpc
+ swiotlb
mm-api
- gfp_mask-from-fs-io
- timekeeping
+ cgroup
+ genalloc
+ pin_user_pages
boot-time-mm
- memory-hotplug
-
+ gfp_mask-from-fs-io
+ kho/index
Interfaces for kernel debugging
===============================
@@ -44,8 +127,21 @@ Interfaces for kernel debugging
debug-objects
tracepoint
+ debugging-via-ohci1394
+
+Everything else
+===============
+
+Documents that don't fit elsewhere or which have yet to be categorized.
+
+.. toctree::
+ :maxdepth: 1
+
+ librs
+ liveupdate
+ netlink
-.. only:: subproject
+.. only:: subproject and html
Indices
=======