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