1======================
  2Core API Documentation
  3======================
  4
  5This is the beginning of a manual for core kernel APIs.  The conversion
  6(and writing!) of documents for this manual is much appreciated!
  7
  8Core utilities
  9==============
 10
 11This section has general and "core core" documentation.  The first is a
 12massive grab-bag of kerneldoc info left over from the docbook days; it
 13should really be broken up someday when somebody finds the energy to do
 14it.
 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
 28Data structures and low-level utilities
 29=======================================
 30
 31Library 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
 52Low level entry and exit
 53========================
 54
 55.. toctree::
 56   :maxdepth: 1
 57
 58   entry
 59
 60Concurrency primitives
 61======================
 62
 63How Linux keeps everything from happening at the same time.  See
 64Documentation/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
 76Low-level hardware management
 77=============================
 78
 79Cache 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
 90Memory management
 91=================
 92
 93How to allocate and use memory in the kernel.  Note that there is a lot
 94more 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
111Interfaces for kernel debugging
112===============================
113
114.. toctree::
115   :maxdepth: 1
116
117   debug-objects
118   tracepoint
119   debugging-via-ohci1394
120
121Everything else
122===============
123
124Documents 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`

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