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