143 lines · plain
1======================2Core API Documentation3======================4 5This is the beginning of a manual for core kernel APIs. The conversion6(and writing!) of documents for this manual is much appreciated!7 8Core utilities9==============10 11This section has general and "core core" documentation. The first is a12massive grab-bag of kerneldoc info left over from the docbook days; it13should really be broken up someday when somebody finds the energy to do14it.15 16.. toctree::17 :maxdepth: 118 19 kernel-api20 workqueue21 watch_queue22 printk-basics23 printk-formats24 printk-index25 symbol-namespaces26 asm-annotations27 28Data structures and low-level utilities29=======================================30 31Library functionality that is used throughout the kernel.32 33.. toctree::34 :maxdepth: 135 36 kobject37 kref38 cleanup39 assoc_array40 folio_queue41 xarray42 maple_tree43 idr44 circular-buffers45 rbtree46 generic-radix-tree47 packing48 this_cpu_ops49 timekeeping50 errseq51 wrappers/atomic_t52 wrappers/atomic_bitops53 floating-point54 union_find55 56Low level entry and exit57========================58 59.. toctree::60 :maxdepth: 161 62 entry63 64Concurrency primitives65======================66 67How Linux keeps everything from happening at the same time. See68Documentation/locking/index.rst for more related documentation.69 70.. toctree::71 :maxdepth: 172 73 refcount-vs-atomic74 irq/index75 local_ops76 padata77 ../RCU/index78 wrappers/memory-barriers.rst79 80Low-level hardware management81=============================82 83Cache management, managing CPU hotplug, etc.84 85.. toctree::86 :maxdepth: 187 88 cachetlb89 cpu_hotplug90 memory-hotplug91 genericirq92 protection-keys93 94Memory management95=================96 97How to allocate and use memory in the kernel. Note that there is a lot98more memory-management documentation in Documentation/mm/index.rst.99 100.. toctree::101 :maxdepth: 1102 103 memory-allocation104 unaligned-memory-access105 dma-api106 dma-api-howto107 dma-attributes108 dma-isa-lpc109 swiotlb110 mm-api111 genalloc112 pin_user_pages113 boot-time-mm114 gfp_mask-from-fs-io115 116Interfaces for kernel debugging117===============================118 119.. toctree::120 :maxdepth: 1121 122 debug-objects123 tracepoint124 debugging-via-ohci1394125 126Everything else127===============128 129Documents that don't fit elsewhere or which have yet to be categorized.130 131.. toctree::132 :maxdepth: 1133 134 librs135 netlink136 137.. only:: subproject and html138 139 Indices140 =======141 142 * :ref:`genindex`143