projects / mirror_ubuntu-jammy-kernel.git / blame
| Commit | Line | Data |
|---|---|---|
| 24755a55 | 1 | ====================== |
| 93dc3a11 | 2 | Core API Documentation |
| 24755a55 SF |
3 | ====================== |
| 4 | ||
| 93dc3a11 JC |
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 | ============== | |
| 24755a55 | 10 | |
| 5e720172 JC |
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 | ||
| 24755a55 SF |
16 | .. toctree:: |
| 17 | :maxdepth: 1 | |
| 18 | ||
| baca8a0c | 19 | kernel-api |
| 5e720172 | 20 | workqueue |
| 90c165f0 | 21 | printk-basics |
| 5e720172 JC |
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 | ||
| 5fed00dc | 33 | kobject |
| 1ac00669 | 34 | kref |
| c3cbf1a7 | 35 | assoc_array |
| 5e720172 JC |
36 | xarray |
| 37 | idr | |
| 38 | circular-buffers | |
| 14bbe3e3 | 39 | rbtree |
| 5e720172 JC |
40 | generic-radix-tree |
| 41 | packing | |
| 42 | timekeeping | |
| 43 | errseq | |
| 44 | ||
| 45 | Concurrency primitives | |
| 46 | ====================== | |
| 47 | ||
| 48 | How Linux keeps everything from happening at the same time. See | |
| 49 | :doc:`/locking/index` for more related documentation. | |
| 50 | ||
| 51 | .. toctree:: | |
| 52 | :maxdepth: 1 | |
| 53 | ||
| 326bc876 | 54 | atomic_ops |
| b6e859f6 | 55 | refcount-vs-atomic |
| e00b0ab8 | 56 | irq/index |
| c232694e | 57 | local_ops |
| 5e720172 JC |
58 | padata |
| 59 | ../RCU/index | |
| 60 | ||
| 61 | Low-level hardware management | |
| 62 | ============================= | |
| 63 | ||
| 64 | Cache management, managing CPU hotplug, etc. | |
| 65 | ||
| 66 | .. toctree:: | |
| 67 | :maxdepth: 1 | |
| 68 | ||
| 69 | cachetlb | |
| 70 | cpu_hotplug | |
| 71 | memory-hotplug | |
| 3bd3b99a | 72 | genericirq |
| 5e720172 JC |
73 | protection-keys |
| 74 | ||
| 75 | Memory management | |
| 76 | ================= | |
| 77 | ||
| 78 | How to allocate and use memory in the kernel. Note that there is a lot | |
| 79 | more memory-management documentation in :doc:`/vm/index`. | |
| 80 | ||
| 81 | .. toctree:: | |
| 82 | :maxdepth: 1 | |
| 83 | ||
| 52272c92 | 84 | memory-allocation |
| 728c1471 MCC |
85 | dma-api |
| 86 | dma-api-howto | |
| 87 | dma-attributes | |
| 88 | dma-isa-lpc | |
| 41f35b39 | 89 | mm-api |
| 5e720172 | 90 | genalloc |
| eddb1c22 | 91 | pin_user_pages |
| ae9d8845 | 92 | boot-time-mm |
| 5e720172 | 93 | gfp_mask-from-fs-io |
| e7f08ffb | 94 | |
| 93dc3a11 JC |
95 | Interfaces for kernel debugging |
| 96 | =============================== | |
| 97 | ||
| 98 | .. toctree:: | |
| 99 | :maxdepth: 1 | |
| 100 | ||
| d6ba7a9c JC |
101 | debug-objects |
| 102 | tracepoint | |
| a74e2a22 | 103 | debugging-via-ohci1394 |
| 93dc3a11 | 104 | |
| 5e720172 JC |
105 | Everything else |
| 106 | =============== | |
| 107 | ||
| 108 | Documents that don't fit elsewhere or which have yet to be categorized. | |
| 109 | ||
| 110 | .. toctree:: | |
| 111 | :maxdepth: 1 | |
| 112 | ||
| 113 | librs | |
| 5e720172 | 114 | |
| 9c970ab5 | 115 | .. only:: subproject and html |
| 24755a55 SF |
116 | |
| 117 | Indices | |
| 118 | ======= | |
| 119 | ||
| 120 | * :ref:`genindex` |