.. | .. |
---|
| 1 | +.. SPDX-License-Identifier: GPL-2.0 |
---|
| 2 | + |
---|
| 3 | + |
---|
1 | 4 | .. The Linux Kernel documentation master file, created by |
---|
2 | 5 | sphinx-quickstart on Fri Feb 12 13:51:46 2016. |
---|
3 | 6 | You can adapt this file completely to your liking, but it should at least |
---|
.. | .. |
---|
22 | 25 | (GPLv2), how to properly mark the license of individual files in the source |
---|
23 | 26 | tree, as well as links to the full license text. |
---|
24 | 27 | |
---|
25 | | -.. toctree:: |
---|
26 | | - :maxdepth: 2 |
---|
27 | | - |
---|
28 | | - process/license-rules.rst |
---|
| 28 | +* :ref:`kernel_licensing` |
---|
29 | 29 | |
---|
30 | 30 | User-oriented documentation |
---|
31 | 31 | --------------------------- |
---|
.. | .. |
---|
37 | 37 | :maxdepth: 2 |
---|
38 | 38 | |
---|
39 | 39 | admin-guide/index |
---|
| 40 | + kbuild/index |
---|
| 41 | + |
---|
| 42 | +Firmware-related documentation |
---|
| 43 | +------------------------------ |
---|
| 44 | +The following holds information on the kernel's expectations regarding the |
---|
| 45 | +platform firmwares. |
---|
| 46 | + |
---|
| 47 | +.. toctree:: |
---|
| 48 | + :maxdepth: 2 |
---|
| 49 | + |
---|
| 50 | + firmware-guide/index |
---|
| 51 | + devicetree/index |
---|
40 | 52 | |
---|
41 | 53 | Application-developer documentation |
---|
42 | 54 | ----------------------------------- |
---|
.. | .. |
---|
68 | 80 | kernel-hacking/index |
---|
69 | 81 | trace/index |
---|
70 | 82 | maintainer/index |
---|
| 83 | + fault-injection/index |
---|
| 84 | + livepatch/index |
---|
| 85 | + |
---|
71 | 86 | |
---|
72 | 87 | Kernel API documentation |
---|
73 | 88 | ------------------------ |
---|
.. | .. |
---|
83 | 98 | |
---|
84 | 99 | driver-api/index |
---|
85 | 100 | core-api/index |
---|
86 | | - media/index |
---|
| 101 | + locking/index |
---|
| 102 | + accounting/index |
---|
| 103 | + block/index |
---|
| 104 | + cdrom/index |
---|
| 105 | + cpu-freq/index |
---|
| 106 | + ide/index |
---|
| 107 | + fb/index |
---|
| 108 | + fpga/index |
---|
| 109 | + hid/index |
---|
| 110 | + i2c/index |
---|
| 111 | + iio/index |
---|
| 112 | + isdn/index |
---|
| 113 | + infiniband/index |
---|
| 114 | + leds/index |
---|
| 115 | + netlabel/index |
---|
87 | 116 | networking/index |
---|
| 117 | + pcmcia/index |
---|
| 118 | + power/index |
---|
| 119 | + target/index |
---|
| 120 | + timers/index |
---|
| 121 | + spi/index |
---|
| 122 | + w1/index |
---|
| 123 | + watchdog/index |
---|
| 124 | + virt/index |
---|
88 | 125 | input/index |
---|
| 126 | + hwmon/index |
---|
89 | 127 | gpu/index |
---|
90 | 128 | security/index |
---|
91 | 129 | sound/index |
---|
.. | .. |
---|
93 | 131 | filesystems/index |
---|
94 | 132 | vm/index |
---|
95 | 133 | bpf/index |
---|
| 134 | + usb/index |
---|
| 135 | + PCI/index |
---|
| 136 | + scsi/index |
---|
| 137 | + misc-devices/index |
---|
| 138 | + scheduler/index |
---|
| 139 | + mhi/index |
---|
| 140 | + |
---|
| 141 | +Architecture-agnostic documentation |
---|
| 142 | +----------------------------------- |
---|
| 143 | + |
---|
| 144 | +.. toctree:: |
---|
| 145 | + :maxdepth: 2 |
---|
| 146 | + |
---|
| 147 | + asm-annotations |
---|
96 | 148 | |
---|
97 | 149 | Architecture-specific documentation |
---|
98 | 150 | ----------------------------------- |
---|
.. | .. |
---|
103 | 155 | .. toctree:: |
---|
104 | 156 | :maxdepth: 2 |
---|
105 | 157 | |
---|
| 158 | + arm/index |
---|
| 159 | + arm64/index |
---|
| 160 | + ia64/index |
---|
| 161 | + m68k/index |
---|
| 162 | + mips/index |
---|
| 163 | + nios2/nios2 |
---|
| 164 | + openrisc/index |
---|
| 165 | + parisc/index |
---|
| 166 | + powerpc/index |
---|
| 167 | + riscv/index |
---|
| 168 | + s390/index |
---|
106 | 169 | sh/index |
---|
| 170 | + sparc/index |
---|
107 | 171 | x86/index |
---|
| 172 | + xtensa/index |
---|
108 | 173 | |
---|
109 | 174 | Filesystem Documentation |
---|
110 | 175 | ------------------------ |
---|
.. | .. |
---|
117 | 182 | |
---|
118 | 183 | filesystems/ext4/index |
---|
119 | 184 | |
---|
| 185 | +Other documentation |
---|
| 186 | +------------------- |
---|
| 187 | + |
---|
| 188 | +There are several unsorted documents that don't seem to fit on other parts |
---|
| 189 | +of the documentation body, or may require some adjustments and/or conversion |
---|
| 190 | +to ReStructured Text format, or are simply too old. |
---|
| 191 | + |
---|
| 192 | +.. toctree:: |
---|
| 193 | + :maxdepth: 2 |
---|
| 194 | + |
---|
| 195 | + staging/index |
---|
| 196 | + watch_queue |
---|
| 197 | + |
---|
| 198 | + |
---|
120 | 199 | Translations |
---|
121 | 200 | ------------ |
---|
122 | 201 | |
---|