Merge tag 'docs-4.12-2' of git://git.lwn.net/linux
[sfrench/cifs-2.6.git] / Documentation / index.rst
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
6 Welcome to The Linux Kernel's documentation
7 ===========================================
8
9 This is the top level of the kernel's documentation tree.  Kernel
10 documentation, like the kernel itself, is very much a work in progress;
11 that is especially true as we work to integrate our many scattered
12 documents into a coherent whole.  Please note that improvements to the
13 documentation are welcome; join the linux-doc list at vger.kernel.org if
14 you want to help out.
15
16 User-oriented documentation
17 ---------------------------
18
19 The following manuals are written for *users* of the kernel — those who are
20 trying to get it to work optimally on a given system.
21
22 .. toctree::
23    :maxdepth: 2
24
25    admin-guide/index
26
27 Application-developer documentation
28 -----------------------------------
29
30 The user-space API manual gathers together documents describing aspects of
31 the kernel interface as seen by application developers.
32
33 .. toctree::
34    :maxdepth: 2
35
36    userspace-api/index        
37
38
39 Introduction to kernel development
40 ----------------------------------
41
42 These manuals contain overall information about how to develop the kernel.
43 The kernel community is quite large, with thousands of developers
44 contributing over the course of a year.  As with any large community,
45 knowing how things are done will make the process of getting your changes
46 merged much easier.
47
48 .. toctree::
49    :maxdepth: 2
50
51    process/index
52    dev-tools/index
53    doc-guide/index
54
55 Kernel API documentation
56 ------------------------
57
58 These books get into the details of how specific kernel subsystems work
59 from the point of view of a kernel developer.  Much of the information here
60 is taken directly from the kernel source, with supplemental material added
61 as needed (or at least as we managed to add it — probably *not* all that is
62 needed).
63
64 .. toctree::
65    :maxdepth: 2
66
67    driver-api/index
68    core-api/index
69    media/index
70    input/index
71    gpu/index
72    security/index
73    sound/index
74    crypto/index
75
76 Korean translations
77 -------------------
78
79 .. toctree::
80    :maxdepth: 1
81
82    translations/ko_KR/index
83
84 Chinese translations
85 --------------------
86
87 .. toctree::
88    :maxdepth: 1
89
90    translations/zh_CN/index
91
92 Japanese translations
93 ---------------------
94
95 .. toctree::
96    :maxdepth: 1
97
98    translations/ja_JP/index
99
100 Indices and tables
101 ==================
102
103 * :ref:`genindex`