LXR linux/Documentation/core-api/index.rst

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