iio: potentiometer: merge calls to of_match_device and of_device_get_match_data
[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
82381918 48 userspace-api/index
1d596dee
JC
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
583bc6ba 67 trace/index
9727a014 68 maintainer/index
b51208d4
JC
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
2069889f 77needed).
b51208d4
JC
78
79.. toctree::
80 :maxdepth: 2
81
dcec3c8c 82 driver-api/index
24755a55 83 core-api/index
b32febad 84 media/index
05e0f3b9 85 networking/index
aeb899af 86 input/index
cb597fce 87 gpu/index
799a545b 88 security/index
8551914a 89 sound/index
3b72c814 90 crypto/index
90f9f118 91 filesystems/index
82381918 92 vm/index
22cba31b 93
bffac837
MCC
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
ba42c574
SP
105Korean translations
106-------------------
107
108.. toctree::
109 :maxdepth: 1
110
111 translations/ko_KR/index
112
2069889f
AD
113Chinese translations
114--------------------
115
116.. toctree::
117 :maxdepth: 1
118
119 translations/zh_CN/index
120
f0127338
TS
121Japanese translations
122---------------------
123
124.. toctree::
125 :maxdepth: 1
126
127 translations/ja_JP/index
128
22cba31b
JN
129Indices and tables
130==================
131
132* :ref:`genindex`