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