Commit 5e720172 authored by Jonathan Corbet's avatar Jonathan Corbet

docs: Organize core-api/index.rst

The core-api manual has become a big, disorganized mess.  Try to bring a
small amount of order to it by organizing the documents into
subcategories.
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent d8401f50
...@@ -8,42 +8,81 @@ This is the beginning of a manual for core kernel APIs. The conversion ...@@ -8,42 +8,81 @@ This is the beginning of a manual for core kernel APIs. The conversion
Core utilities 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:: .. toctree::
:maxdepth: 1 :maxdepth: 1
kernel-api kernel-api
workqueue
printk-formats
symbol-namespaces
Data structures and low-level utilities
=======================================
Library functionality that is used throughout the kernel.
.. toctree::
:maxdepth: 1
kobject kobject
assoc_array assoc_array
xarray
idr
circular-buffers
generic-radix-tree
packing
timekeeping
errseq
Concurrency primitives
======================
How Linux keeps everything from happening at the same time. See
:doc:`/locking/index` for more related documentation.
.. toctree::
:maxdepth: 1
atomic_ops atomic_ops
cachetlb
refcount-vs-atomic refcount-vs-atomic
cpu_hotplug
idr
local_ops local_ops
workqueue padata
../RCU/index
Low-level hardware management
=============================
Cache management, managing CPU hotplug, etc.
.. toctree::
:maxdepth: 1
cachetlb
cpu_hotplug
memory-hotplug
genericirq genericirq
xarray protection-keys
librs
genalloc Memory management
errseq =================
packing
printk-formats How to allocate and use memory in the kernel. Note that there is a lot
circular-buffers more memory-management documentation in :doc:`/vm/index`.
generic-radix-tree
.. toctree::
:maxdepth: 1
memory-allocation memory-allocation
mm-api mm-api
genalloc
pin_user_pages pin_user_pages
gfp_mask-from-fs-io
timekeeping
boot-time-mm boot-time-mm
memory-hotplug gfp_mask-from-fs-io
protection-keys
../RCU/index
gcc-plugins
symbol-namespaces
padata
ioctl
Interfaces for kernel debugging Interfaces for kernel debugging
=============================== ===============================
...@@ -54,6 +93,18 @@ Interfaces for kernel debugging ...@@ -54,6 +93,18 @@ Interfaces for kernel debugging
debug-objects debug-objects
tracepoint tracepoint
Everything else
===============
Documents that don't fit elsewhere or which have yet to be categorized.
.. toctree::
:maxdepth: 1
librs
gcc-plugins
ioctl
.. only:: subproject and html .. only:: subproject and html
Indices Indices
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment