| | 1 | ====================== |
| | 2 | Core API Documentation |
| | 3 | ====================== |
| | 4 | |
| | 5 | This is the beginning of a manual for core kernel APIs. The conversion |
| | 6 | (and writing!) of documents for this manual is much appreciated! |
| | 7 | |
| | 8 | Core utilities |
| | 9 | ============== |
| | 10 | |
| | 11 | This section has general and "core core" documentation. The first is a |
| | 12 | massive grab-bag of kerneldoc info left over from the docbook days; it |
| | 13 | should really be broken up someday when somebody finds the energy to do |
| | 14 | it. |
| | 15 | |
| | 16 | .. toctree:: |
| | 17 | :maxdepth: 1 |
| | 18 | |
| | 19 | kernel-api |
| | 20 | workqueue |
| | 21 | printk-basics |
| | 22 | printk-formats |
| | 23 | symbol-namespaces |
| | 24 | |
| | 25 | Data structures and low-level utilities |
| | 26 | ======================================= |
| | 27 | |
| | 28 | Library functionality that is used throughout the kernel. |
| | 29 | |
| | 30 | .. toctree:: |
| | 31 | :maxdepth: 1 |
| | 32 | |
| | 33 | kobject |
| | 34 | kref |
| | 35 | assoc_array |
| | 36 | xarray |
| | 37 | idr |
| | 38 | circular-buffers |
| | 39 | rbtree |
| | 40 | generic-radix-tree |
| | 41 | packing |
| | 42 | bus-virt-phys-mapping |
| | 43 | this_cpu_ops |
| | 44 | timekeeping |
| | 45 | errseq |
| | 46 | |
| | 47 | Concurrency primitives |
| | 48 | ====================== |
| | 49 | |
| | 50 | How Linux keeps everything from happening at the same time. See |
| | 51 | :doc:`/locking/index` for more related documentation. |
| | 52 | |
| | 53 | .. toctree:: |
| | 54 | :maxdepth: 1 |
| | 55 | |
| | 56 | refcount-vs-atomic |
| | 57 | irq/index |
| | 58 | local_ops |
| | 59 | padata |
| | 60 | ../RCU/index |
| | 61 | |
| | 62 | Low-level hardware management |
| | 63 | ============================= |
| | 64 | |
| | 65 | Cache management, managing CPU hotplug, etc. |
| | 66 | |
| | 67 | .. toctree:: |
| | 68 | :maxdepth: 1 |
| | 69 | |
| | 70 | cachetlb |
| | 71 | cpu_hotplug |
| | 72 | memory-hotplug |
| | 73 | genericirq |
| | 74 | protection-keys |
| | 75 | |
| | 76 | Memory management |
| | 77 | ================= |
| | 78 | |
| | 79 | How to allocate and use memory in the kernel. Note that there is a lot |
| | 80 | more memory-management documentation in :doc:`/vm/index`. |
| | 81 | |
| | 82 | .. toctree:: |
| | 83 | :maxdepth: 1 |
| | 84 | |
| | 85 | memory-allocation |
| | 86 | unaligned-memory-access |
| | 87 | dma-api |
| | 88 | dma-api-howto |
| | 89 | dma-attributes |
| | 90 | dma-isa-lpc |
| | 91 | mm-api |
| | 92 | genalloc |
| | 93 | pin_user_pages |
| | 94 | boot-time-mm |
| | 95 | gfp_mask-from-fs-io |
| | 96 | |
| | 97 | Interfaces for kernel debugging |
| | 98 | =============================== |
| | 99 | |
| | 100 | .. toctree:: |
| | 101 | :maxdepth: 1 |
| | 102 | |
| | 103 | debug-objects |
| | 104 | tracepoint |
| | 105 | debugging-via-ohci1394 |
| | 106 | |
| | 107 | Everything else |
| | 108 | =============== |
| | 109 | |
| | 110 | Documents that don't fit elsewhere or which have yet to be categorized. |
| | 111 | |
| | 112 | .. toctree:: |
| | 113 | :maxdepth: 1 |
| | 114 | |
| | 115 | librs |
| | 116 | |
| | 117 | .. only:: subproject and html |
| | 118 | |
| | 119 | Indices |
| | 120 | ======= |
| | 121 | |
| | 122 | * :ref:`genindex` |
projects / mirror_ubuntu-hirsute-kernel.git / blame_incremental