Documentation/core-api/index.rst

   1 ======================
   2 Core API Documentation
   3 ======================
   4
   5 This is the beginning of a manual for core kernel APIs.  The conversion
   6 (and writing!) of documents for this manual is much appreciated!
   7
   8 Core utilities
   9 ==============
  10
  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
  16 .. toctree::
  17    :maxdepth: 1
  18
  19    kernel-api
  20    workqueue
  21    watch_queue
  22    printk-basics
  23    printk-formats
  24    printk-index
  25    symbol-namespaces
  26
  27 Data structures and low-level utilities
  28 =======================================
  29
  30 Library functionality that is used throughout the kernel.
  31
  32 .. toctree::
  33    :maxdepth: 1
  34
  35    kobject
  36    kref
  37    assoc_array
  38    xarray
  39    idr
  40    circular-buffers
  41    rbtree
  42    generic-radix-tree
  43    packing
  44    this_cpu_ops
  45    timekeeping
  46    errseq
  47
  48 Low level entry and exit
  49 ========================
  50
  51 .. toctree::
  52    :maxdepth: 1
  53
  54    entry
  55
  56 Concurrency primitives
  57 ======================
  58
  59 How Linux keeps everything from happening at the same time.  See
  60 Documentation/locking/index.rst for more related documentation.
  61
  62 .. toctree::
  63    :maxdepth: 1
  64
  65    refcount-vs-atomic
  66    irq/index
  67    local_ops
  68    padata
  69    ../RCU/index
  70
  71 Low-level hardware management
  72 =============================
  73
  74 Cache management, managing CPU hotplug, etc.
  75
  76 .. toctree::
  77    :maxdepth: 1
  78
  79    cachetlb
  80    cpu_hotplug
  81    memory-hotplug
  82    genericirq
  83    protection-keys
  84
  85 Memory management
  86 =================
  87
  88 How to allocate and use memory in the kernel.  Note that there is a lot
  89 more memory-management documentation in Documentation/mm/index.rst.
  90
  91 .. toctree::
  92    :maxdepth: 1
  93
  94    memory-allocation
  95    unaligned-memory-access
  96    dma-api
  97    dma-api-howto
  98    dma-attributes
  99    dma-isa-lpc
 100    mm-api
 101    genalloc
 102    pin_user_pages
 103    boot-time-mm
 104    gfp_mask-from-fs-io
 105
 106 Interfaces for kernel debugging
 107 ===============================
 108
 109 .. toctree::
 110    :maxdepth: 1
 111
 112    debug-objects
 113    tracepoint
 114    debugging-via-ohci1394
 115
 116 Everything else
 117 ===============
 118
 119 Documents that don't fit elsewhere or which have yet to be categorized.
 120
 121 .. toctree::
 122    :maxdepth: 1
 123
 124    librs
 125
 126 .. only:: subproject and html
 127
 128    Indices
 129    =======
 130
 131    * :ref:`genindex`