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