| Silvio Fricke | 24755a5 | 2016-10-28 10:14:10 +0200 | [diff] [blame] | 1 | ====================== |
| Jonathan Corbet | 93dc3a1 | 2016-11-18 17:06:13 -0700 | [diff] [blame] | 2 | Core API Documentation |
| Silvio Fricke | 24755a5 | 2016-10-28 10:14:10 +0200 | [diff] [blame] | 3 | ====================== |
| 4 | |
| Jonathan Corbet | 93dc3a1 | 2016-11-18 17:06:13 -0700 | [diff] [blame] | 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 | ============== |
| Silvio Fricke | 24755a5 | 2016-10-28 10:14:10 +0200 | [diff] [blame] | 10 | |
| Jonathan Corbet | 5e72017 | 2020-03-02 15:17:17 -0700 | [diff] [blame] | 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 | |
| Silvio Fricke | 24755a5 | 2016-10-28 10:14:10 +0200 | [diff] [blame] | 16 | .. toctree:: |
| 17 | :maxdepth: 1 |
| 18 | |
| Mauro Carvalho Chehab | baca8a0 | 2017-03-30 17:11:32 -0300 | [diff] [blame] | 19 | kernel-api |
| Jonathan Corbet | 5e72017 | 2020-03-02 15:17:17 -0700 | [diff] [blame] | 20 | workqueue |
| 21 | printk-formats |
| 22 | symbol-namespaces |
| 23 | |
| 24 | Data structures and low-level utilities |
| 25 | ======================================= |
| 26 | |
| 27 | Library functionality that is used throughout the kernel. |
| 28 | |
| 29 | .. toctree:: |
| 30 | :maxdepth: 1 |
| 31 | |
| Sameer Rahmani | 5fed00d | 2020-02-25 22:21:25 +0000 | [diff] [blame] | 32 | kobject |
| Silvio Fricke | c3cbf1a | 2016-11-28 18:30:53 +0100 | [diff] [blame] | 33 | assoc_array |
| Matthew Wilcox | 992a8e6 | 2017-11-23 22:57:20 -0500 | [diff] [blame] | 34 | xarray |
| Jonathan Corbet | 5e72017 | 2020-03-02 15:17:17 -0700 | [diff] [blame] | 35 | idr |
| Mauro Carvalho Chehab | d8a121e | 2018-05-07 06:35:43 -0300 | [diff] [blame] | 36 | circular-buffers |
| Kent Overstreet | ba20ba2 | 2019-03-11 23:31:14 -0700 | [diff] [blame] | 37 | generic-radix-tree |
| Jonathan Corbet | 5e72017 | 2020-03-02 15:17:17 -0700 | [diff] [blame] | 38 | packing |
| 39 | timekeeping |
| 40 | errseq |
| 41 | |
| 42 | Concurrency primitives |
| 43 | ====================== |
| 44 | |
| 45 | How Linux keeps everything from happening at the same time. See |
| 46 | :doc:`/locking/index` for more related documentation. |
| 47 | |
| 48 | .. toctree:: |
| 49 | :maxdepth: 1 |
| 50 | |
| 51 | atomic_ops |
| 52 | refcount-vs-atomic |
| 53 | local_ops |
| 54 | padata |
| 55 | ../RCU/index |
| 56 | |
| 57 | Low-level hardware management |
| 58 | ============================= |
| 59 | |
| 60 | Cache management, managing CPU hotplug, etc. |
| 61 | |
| 62 | .. toctree:: |
| 63 | :maxdepth: 1 |
| 64 | |
| 65 | cachetlb |
| 66 | cpu_hotplug |
| 67 | memory-hotplug |
| 68 | genericirq |
| 69 | protection-keys |
| 70 | |
| 71 | Memory management |
| 72 | ================= |
| 73 | |
| 74 | How to allocate and use memory in the kernel. Note that there is a lot |
| 75 | more memory-management documentation in :doc:`/vm/index`. |
| 76 | |
| 77 | .. toctree:: |
| 78 | :maxdepth: 1 |
| 79 | |
| Mike Rapoport | 52272c9 | 2018-09-14 12:27:58 +0300 | [diff] [blame] | 80 | memory-allocation |
| Mike Rapoport | 41f35b3 | 2018-08-23 17:01:12 -0700 | [diff] [blame] | 81 | mm-api |
| Jonathan Corbet | 5e72017 | 2020-03-02 15:17:17 -0700 | [diff] [blame] | 82 | genalloc |
| John Hubbard | eddb1c2 | 2020-01-30 22:12:54 -0800 | [diff] [blame] | 83 | pin_user_pages |
| Mike Rapoport | ae9d884 | 2018-06-30 17:55:06 +0300 | [diff] [blame] | 84 | boot-time-mm |
| Jonathan Corbet | 5e72017 | 2020-03-02 15:17:17 -0700 | [diff] [blame] | 85 | gfp_mask-from-fs-io |
| Silvio Fricke | e7f08ff | 2016-10-28 10:14:11 +0200 | [diff] [blame] | 86 | |
| Jonathan Corbet | 93dc3a1 | 2016-11-18 17:06:13 -0700 | [diff] [blame] | 87 | Interfaces for kernel debugging |
| 88 | =============================== |
| 89 | |
| 90 | .. toctree:: |
| 91 | :maxdepth: 1 |
| 92 | |
| Jonathan Corbet | d6ba7a9 | 2016-11-18 17:21:32 -0700 | [diff] [blame] | 93 | debug-objects |
| 94 | tracepoint |
| Jonathan Corbet | 93dc3a1 | 2016-11-18 17:06:13 -0700 | [diff] [blame] | 95 | |
| Jonathan Corbet | 5e72017 | 2020-03-02 15:17:17 -0700 | [diff] [blame] | 96 | Everything else |
| 97 | =============== |
| 98 | |
| 99 | Documents that don't fit elsewhere or which have yet to be categorized. |
| 100 | |
| 101 | .. toctree:: |
| 102 | :maxdepth: 1 |
| 103 | |
| 104 | librs |
| Jonathan Corbet | 5e72017 | 2020-03-02 15:17:17 -0700 | [diff] [blame] | 105 | |
| Mauro Carvalho Chehab | 9c970ab | 2019-07-26 09:51:29 -0300 | [diff] [blame] | 106 | .. only:: subproject and html |
| Silvio Fricke | 24755a5 | 2016-10-28 10:14:10 +0200 | [diff] [blame] | 107 | |
| 108 | Indices |
| 109 | ======= |
| 110 | |
| 111 | * :ref:`genindex` |