acpi, nfit: remove redundant __func__ in dev_dbg
[linux-2.6-block.git] / Documentation / index.rst
CommitLineData
22cba31b
JN
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
61ca5fd1
KR
6The Linux Kernel documentation
7==============================
22cba31b 8
b51208d4
JC
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
aa19a176
TG
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
b51208d4
JC
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.
22cba31b
JN
33
34.. toctree::
35 :maxdepth: 2
36
9d85025b 37 admin-guide/index
b51208d4 38
1d596dee
JC
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
b51208d4
JC
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
0e4f07a6 63 process/index
c289312f 64 dev-tools/index
1dc4bbf0 65 doc-guide/index
c4fcd7ca 66 kernel-hacking/index
9727a014 67 maintainer/index
b51208d4
JC
68
69Kernel API documentation
70------------------------
71
72These books get into the details of how specific kernel subsystems work
73from the point of view of a kernel developer. Much of the information here
74is taken directly from the kernel source, with supplemental material added
75as needed (or at least as we managed to add it — probably *not* all that is
2069889f 76needed).
b51208d4
JC
77
78.. toctree::
79 :maxdepth: 2
80
dcec3c8c 81 driver-api/index
24755a55 82 core-api/index
b32febad 83 media/index
05e0f3b9 84 networking/index
aeb899af 85 input/index
cb597fce 86 gpu/index
799a545b 87 security/index
8551914a 88 sound/index
3b72c814 89 crypto/index
90f9f118 90 filesystems/index
22cba31b 91
bffac837
MCC
92Architecture-specific documentation
93-----------------------------------
94
95These books provide programming details about architecture-specific
96implementation.
97
98.. toctree::
99 :maxdepth: 2
100
101 sh/index
102
ba42c574
SP
103Korean translations
104-------------------
105
106.. toctree::
107 :maxdepth: 1
108
109 translations/ko_KR/index
110
2069889f
AD
111Chinese translations
112--------------------
113
114.. toctree::
115 :maxdepth: 1
116
117 translations/zh_CN/index
118
f0127338
TS
119Japanese translations
120---------------------
121
122.. toctree::
123 :maxdepth: 1
124
125 translations/ja_JP/index
126
22cba31b
JN
127Indices and tables
128==================
129
130* :ref:`genindex`