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