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   netlink
131
132.. only:: subproject and html
133
134   Indices
135   =======
136
137   * :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
 
 
 
 
 
11.. toctree::
12   :maxdepth: 1
13
14   kernel-api
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15   assoc_array
16   atomic_ops
17   cachetlb
18   refcount-vs-atomic
19   cpu_hotplug
20   idr
21   local_ops
22   workqueue
23   genericirq
24   xarray
25   librs
26   genalloc
27   errseq
28   packing
29   printk-formats
30   circular-buffers
 
31   generic-radix-tree
32   memory-allocation
33   mm-api
34   gfp_mask-from-fs-io
35   timekeeping
36   boot-time-mm
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
37   memory-hotplug
 
38   protection-keys
39   ../RCU/index
40   gcc-plugins
41   symbol-namespaces
42
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
43
44Interfaces for kernel debugging
45===============================
46
47.. toctree::
48   :maxdepth: 1
49
50   debug-objects
51   tracepoint
 
 
 
 
 
 
 
 
 
 
 
 
52
53.. only:: subproject and html
54
55   Indices
56   =======
57
58   * :ref:`genindex`