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 27Data structures and low-level utilities 28======================================= 29 30Library functionality that is used throughout the kernel. 31 32.. toctree:: 33 :maxdepth: 1 34 35 kobject 36 kref 37 assoc_array 38 xarray 39 idr 40 circular-buffers 41 rbtree 42 generic-radix-tree 43 packing 44 this_cpu_ops 45 timekeeping 46 errseq 47 48Low level entry and exit 49======================== 50 51.. toctree:: 52 :maxdepth: 1 53 54 entry 55 56Concurrency primitives 57====================== 58 59How Linux keeps everything from happening at the same time. See 60Documentation/locking/index.rst for more related documentation. 61 62.. toctree:: 63 :maxdepth: 1 64 65 refcount-vs-atomic 66 irq/index 67 local_ops 68 padata 69 ../RCU/index 70 71Low-level hardware management 72============================= 73 74Cache management, managing CPU hotplug, etc. 75 76.. toctree:: 77 :maxdepth: 1 78 79 cachetlb 80 cpu_hotplug 81 memory-hotplug 82 genericirq 83 protection-keys 84 85Memory management 86================= 87 88How to allocate and use memory in the kernel. Note that there is a lot 89more memory-management documentation in Documentation/mm/index.rst. 90 91.. toctree:: 92 :maxdepth: 1 93 94 memory-allocation 95 unaligned-memory-access 96 dma-api 97 dma-api-howto 98 dma-attributes 99 dma-isa-lpc 100 mm-api 101 genalloc 102 pin_user_pages 103 boot-time-mm 104 gfp_mask-from-fs-io 105 106Interfaces for kernel debugging 107=============================== 108 109.. toctree:: 110 :maxdepth: 1 111 112 debug-objects 113 tracepoint 114 debugging-via-ohci1394 115 116Everything else 117=============== 118 119Documents that don't fit elsewhere or which have yet to be categorized. 120 121.. toctree:: 122 :maxdepth: 1 123 124 librs 125 126.. only:: subproject and html 127 128 Indices 129 ======= 130 131 * :ref:`genindex` 132