Merge branches 'pm-cpufreq-x86', 'pm-cpufreq-docs' and 'intel_pstate'
[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 The Linux Kernel 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    kernel-hacking/index
55
56 Kernel API documentation
57 ------------------------
58
59 These books get into the details of how specific kernel subsystems work
60 from the point of view of a kernel developer.  Much of the information here
61 is taken directly from the kernel source, with supplemental material added
62 as needed (or at least as we managed to add it — probably *not* all that is
63 needed).
64
65 .. toctree::
66    :maxdepth: 2
67
68    driver-api/index
69    core-api/index
70    media/index
71    networking/index
72    input/index
73    gpu/index
74    security/index
75    sound/index
76    crypto/index
77    filesystems/index
78
79 Architecture-specific documentation
80 -----------------------------------
81
82 These books provide programming details about architecture-specific
83 implementation.
84
85 .. toctree::
86    :maxdepth: 2
87
88    sh/index
89
90 Korean translations
91 -------------------
92
93 .. toctree::
94    :maxdepth: 1
95
96    translations/ko_KR/index
97
98 Chinese translations
99 --------------------
100
101 .. toctree::
102    :maxdepth: 1
103
104    translations/zh_CN/index
105
106 Japanese translations
107 ---------------------
108
109 .. toctree::
110    :maxdepth: 1
111
112    translations/ja_JP/index
113
114 Indices and tables
115 ==================
116
117 * :ref:`genindex`