hc
2024-10-12 a5969cabbb4660eab42b6ef0412cbbd1200cf14d
kernel/Documentation/index.rst
....@@ -1,3 +1,6 @@
1
+.. SPDX-License-Identifier: GPL-2.0
2
+
3
+
14 .. The Linux Kernel documentation master file, created by
25 sphinx-quickstart on Fri Feb 12 13:51:46 2016.
36 You can adapt this file completely to your liking, but it should at least
....@@ -22,10 +25,7 @@
2225 (GPLv2), how to properly mark the license of individual files in the source
2326 tree, as well as links to the full license text.
2427
25
-.. toctree::
26
- :maxdepth: 2
27
-
28
- process/license-rules.rst
28
+* :ref:`kernel_licensing`
2929
3030 User-oriented documentation
3131 ---------------------------
....@@ -37,6 +37,18 @@
3737 :maxdepth: 2
3838
3939 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
4052
4153 Application-developer documentation
4254 -----------------------------------
....@@ -68,6 +80,9 @@
6880 kernel-hacking/index
6981 trace/index
7082 maintainer/index
83
+ fault-injection/index
84
+ livepatch/index
85
+
7186
7287 Kernel API documentation
7388 ------------------------
....@@ -83,9 +98,32 @@
8398
8499 driver-api/index
85100 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
87116 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
88125 input/index
126
+ hwmon/index
89127 gpu/index
90128 security/index
91129 sound/index
....@@ -93,6 +131,20 @@
93131 filesystems/index
94132 vm/index
95133 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
96148
97149 Architecture-specific documentation
98150 -----------------------------------
....@@ -103,8 +155,21 @@
103155 .. toctree::
104156 :maxdepth: 2
105157
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
106169 sh/index
170
+ sparc/index
107171 x86/index
172
+ xtensa/index
108173
109174 Filesystem Documentation
110175 ------------------------
....@@ -117,6 +182,20 @@
117182
118183 filesystems/ext4/index
119184
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
+
120199 Translations
121200 ------------
122201