docs: add arch doc directories to the index
[sfrench/cifs-2.6.git] / Documentation / index.rst
1
2 .. The Linux Kernel documentation master file, created by
3    sphinx-quickstart on Fri Feb 12 13:51:46 2016.
4    You can adapt this file completely to your liking, but it should at least
5    contain the root `toctree` directive.
6
7 .. _linux_doc:
8
9 The Linux Kernel documentation
10 ==============================
11
12 This is the top level of the kernel's documentation tree.  Kernel
13 documentation, like the kernel itself, is very much a work in progress;
14 that is especially true as we work to integrate our many scattered
15 documents into a coherent whole.  Please note that improvements to the
16 documentation are welcome; join the linux-doc list at vger.kernel.org if
17 you want to help out.
18
19 Licensing documentation
20 -----------------------
21
22 The following describes the license of the Linux kernel source code
23 (GPLv2), how to properly mark the license of individual files in the source
24 tree, as well as links to the full license text.
25
26 * :ref:`kernel_licensing`
27
28 User-oriented documentation
29 ---------------------------
30
31 The following manuals are written for *users* of the kernel — those who are
32 trying to get it to work optimally on a given system.
33
34 .. toctree::
35    :maxdepth: 2
36
37    admin-guide/index
38
39 Firmware-related documentation
40 ------------------------------
41 The following holds information on the kernel's expectations regarding the
42 platform firmwares.
43
44 .. toctree::
45    :maxdepth: 2
46
47    firmware-guide/index
48
49 Application-developer documentation
50 -----------------------------------
51
52 The user-space API manual gathers together documents describing aspects of
53 the kernel interface as seen by application developers.
54
55 .. toctree::
56    :maxdepth: 2
57
58    userspace-api/index
59    ioctl/index
60
61
62 Introduction to kernel development
63 ----------------------------------
64
65 These manuals contain overall information about how to develop the kernel.
66 The kernel community is quite large, with thousands of developers
67 contributing over the course of a year.  As with any large community,
68 knowing how things are done will make the process of getting your changes
69 merged much easier.
70
71 .. toctree::
72    :maxdepth: 2
73
74    process/index
75    dev-tools/index
76    doc-guide/index
77    kernel-hacking/index
78    trace/index
79    maintainer/index
80
81 Kernel API documentation
82 ------------------------
83
84 These books get into the details of how specific kernel subsystems work
85 from the point of view of a kernel developer.  Much of the information here
86 is taken directly from the kernel source, with supplemental material added
87 as needed (or at least as we managed to add it — probably *not* all that is
88 needed).
89
90 .. toctree::
91    :maxdepth: 2
92
93    driver-api/index
94    core-api/index
95    leds/index
96    media/index
97    networking/index
98    input/index
99    hwmon/index
100    gpu/index
101    security/index
102    sound/index
103    crypto/index
104    filesystems/index
105    vm/index
106    bpf/index
107    usb/index
108    misc-devices/index
109
110 Architecture-specific documentation
111 -----------------------------------
112
113 These books provide programming details about architecture-specific
114 implementation.
115
116 .. toctree::
117    :maxdepth: 2
118
119    sh/index
120    arm/index
121    arm64/index
122    ia64/index
123    m68k/index
124    riscv/index
125    s390/index
126    sh/index
127    sparc/index
128    x86/index
129    xtensa/index
130
131 Filesystem Documentation
132 ------------------------
133
134 The documentation in this section are provided by specific filesystem
135 subprojects.
136
137 .. toctree::
138    :maxdepth: 2
139
140    filesystems/ext4/index
141
142 Translations
143 ------------
144
145 .. toctree::
146    :maxdepth: 2
147
148    translations/index
149
150 Indices and tables
151 ==================
152
153 * :ref:`genindex`