xref: /openbmc/linux/Documentation/index.rst (revision 8730046c)
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
6Welcome to The Linux Kernel's 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
16User-oriented documentation
17---------------------------
18
19The following manuals are written for *users* of the kernel — those who are
20trying to get it to work optimally on a given system.
21
22.. toctree::
23   :maxdepth: 2
24
25   admin-guide/index
26
27Introduction to kernel development
28----------------------------------
29
30These manuals contain overall information about how to develop the kernel.
31The kernel community is quite large, with thousands of developers
32contributing over the course of a year.  As with any large community,
33knowing how things are done will make the process of getting your changes
34merged much easier.
35
36.. toctree::
37   :maxdepth: 2
38
39   process/index
40   dev-tools/index
41   doc-guide/index
42
43Kernel API documentation
44------------------------
45
46These books get into the details of how specific kernel subsystems work
47from the point of view of a kernel developer.  Much of the information here
48is taken directly from the kernel source, with supplemental material added
49as needed (or at least as we managed to add it — probably *not* all that is
50needed).
51
52.. toctree::
53   :maxdepth: 2
54
55   driver-api/index
56   core-api/index
57   media/index
58   gpu/index
59   security/index
60   sound/index
61   crypto/index
62
63Korean translations
64-------------------
65
66.. toctree::
67   :maxdepth: 1
68
69   translations/ko_KR/index
70
71Indices and tables
72==================
73
74* :ref:`genindex`
75