diff options
Diffstat (limited to 'Documentation/core-api/index.rst')
-rw-r--r-- | Documentation/core-api/index.rst | 121 |
1 files changed, 98 insertions, 23 deletions
diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst index a501dc1c90d0..77eb775b8b42 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -8,41 +8,105 @@ 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 - assoc_array - atomic_ops - cachetlb - refcount-vs-atomic - cpu_hotplug - idr - local_ops workqueue - genericirq - xarray - librs - genalloc - errseq - packing + watch_queue + printk-basics printk-formats + printk-index + symbol-namespaces + asm-annotations + +Data structures and low-level utilities +======================================= + +Library functionality that is used throughout the kernel. + +.. toctree:: + :maxdepth: 1 + + kobject + kref + assoc_array + xarray + maple_tree + idr circular-buffers + rbtree generic-radix-tree - memory-allocation - mm-api - pin_user_pages - gfp_mask-from-fs-io + packing + this_cpu_ops timekeeping - boot-time-mm + errseq + wrappers/atomic_t + wrappers/atomic_bitops + +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 + 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 protection-keys - ../RCU/index - gcc-plugins - symbol-namespaces - padata - ioctl +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 + mm-api + genalloc + pin_user_pages + boot-time-mm + gfp_mask-from-fs-io Interfaces for kernel debugging =============================== @@ -52,6 +116,17 @@ 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 .. only:: subproject and html |