0001 ======================
0002 Core API Documentation
0003 ======================
0004
0005 This is the beginning of a manual for core kernel APIs. The conversion
0006 (and writing!) of documents for this manual is much appreciated!
0007
0008 Core utilities
0009 ==============
0010
0011 This section has general and "core core" documentation. The first is a
0012 massive grab-bag of kerneldoc info left over from the docbook days; it
0013 should really be broken up someday when somebody finds the energy to do
0014 it.
0015
0016 .. toctree::
0017 :maxdepth: 1
0018
0019 kernel-api
0020 workqueue
0021 watch_queue
0022 printk-basics
0023 printk-formats
0024 printk-index
0025 symbol-namespaces
0026
0027 Data structures and low-level utilities
0028 =======================================
0029
0030 Library functionality that is used throughout the kernel.
0031
0032 .. toctree::
0033 :maxdepth: 1
0034
0035 kobject
0036 kref
0037 assoc_array
0038 xarray
0039 idr
0040 circular-buffers
0041 rbtree
0042 generic-radix-tree
0043 packing
0044 this_cpu_ops
0045 timekeeping
0046 errseq
0047
0048 Low level entry and exit
0049 ========================
0050
0051 .. toctree::
0052 :maxdepth: 1
0053
0054 entry
0055
0056 Concurrency primitives
0057 ======================
0058
0059 How Linux keeps everything from happening at the same time. See
0060 Documentation/locking/index.rst for more related documentation.
0061
0062 .. toctree::
0063 :maxdepth: 1
0064
0065 refcount-vs-atomic
0066 irq/index
0067 local_ops
0068 padata
0069 ../RCU/index
0070
0071 Low-level hardware management
0072 =============================
0073
0074 Cache management, managing CPU hotplug, etc.
0075
0076 .. toctree::
0077 :maxdepth: 1
0078
0079 cachetlb
0080 cpu_hotplug
0081 memory-hotplug
0082 genericirq
0083 protection-keys
0084
0085 Memory management
0086 =================
0087
0088 How to allocate and use memory in the kernel. Note that there is a lot
0089 more memory-management documentation in Documentation/mm/index.rst.
0090
0091 .. toctree::
0092 :maxdepth: 1
0093
0094 memory-allocation
0095 unaligned-memory-access
0096 dma-api
0097 dma-api-howto
0098 dma-attributes
0099 dma-isa-lpc
0100 mm-api
0101 genalloc
0102 pin_user_pages
0103 boot-time-mm
0104 gfp_mask-from-fs-io
0105
0106 Interfaces for kernel debugging
0107 ===============================
0108
0109 .. toctree::
0110 :maxdepth: 1
0111
0112 debug-objects
0113 tracepoint
0114 debugging-via-ohci1394
0115
0116 Everything else
0117 ===============
0118
0119 Documents that don't fit elsewhere or which have yet to be categorized.
0120
0121 .. toctree::
0122 :maxdepth: 1
0123
0124 librs
0125
0126 .. only:: subproject and html
0127
0128 Indices
0129 =======
0130
0131 * :ref:`genindex`
