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