Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.19 / 9868c0b2eb18470a91d6f0f0df318738a50554e2 / . / Documentation / index.rst
blob: fdc585703498ee12d6bd76557be307db4d40a9a0 [file] [log] [blame]
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]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
Konstantin Ryabitsev61ca5fd2017-06-06 16:50:04 -0400[diff] [blame]6The Linux Kernel documentation
7==============================
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]8
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]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
Thomas Gleixneraa19a172017-12-28 23:17:17 +0100[diff] [blame]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
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]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.
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]33
34.. toctree::
35 :maxdepth: 2
36
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]37 admin-guide/index
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]38
Jonathan Corbet1d596de2017-04-02 14:58:01 -0600[diff] [blame]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
Mike Rapoport82381912018-03-21 21:22:48 +0200[diff] [blame]48 userspace-api/index
Jonathan Corbet1d596de2017-04-02 14:58:01 -0600[diff] [blame]49
50
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]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
Mauro Carvalho Chehab0e4f07a2016-10-18 09:05:32 -0200[diff] [blame]63 process/index
Markus Heiserc2893122016-10-26 08:23:14 +0200[diff] [blame]64 dev-tools/index
Mauro Carvalho Chehab1dc4bbf2016-11-17 08:32:33 -0200[diff] [blame]65 doc-guide/index
Mauro Carvalho Chehabc4fcd7c2017-05-11 08:03:27 -0300[diff] [blame]66 kernel-hacking/index
Changbin Du583bc6b2018-02-17 13:39:34 +0800[diff] [blame]67 trace/index
Tobin C. Harding9727a012017-12-04 10:27:29 +1100[diff] [blame]68 maintainer/index
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]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
Andy Deng20698892017-01-25 12:14:33 +0800[diff] [blame]77needed).
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]78
79.. toctree::
80 :maxdepth: 2
81
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]82 driver-api/index
Silvio Fricke24755a52016-10-28 10:14:10 +0200[diff] [blame]83 core-api/index
Markus Heiserb32feba2016-08-13 16:12:43 +0200[diff] [blame]84 media/index
Mauro Carvalho Chehab05e0f3b2017-05-12 09:14:02 -0300[diff] [blame]85 networking/index
Mauro Carvalho Chehabaeb899a2017-04-11 07:01:19 -0300[diff] [blame]86 input/index
Jani Nikulacb597fc2016-06-21 14:48:57 +0300[diff] [blame]87 gpu/index
Jarkko Sakkinen799a5452016-11-03 17:57:52 -0600[diff] [blame]88 security/index
Takashi Iwai85519142016-11-02 21:30:39 +0100[diff] [blame]89 sound/index
Stephan Mueller3b72c812016-10-21 04:54:22 +0200[diff] [blame]90 crypto/index
Mauro Carvalho Chehab90f9f112017-05-12 06:50:22 -0300[diff] [blame]91 filesystems/index
Mike Rapoport82381912018-03-21 21:22:48 +0200[diff] [blame]92 vm/index
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]93
Mauro Carvalho Chehabbffac832017-05-13 07:50:43 -0300[diff] [blame]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
SeongJae Parkba42c572016-11-08 21:26:09 +0900[diff] [blame]105Korean translations
106-------------------
107
108.. toctree::
109 :maxdepth: 1
110
111 translations/ko_KR/index
112
Andy Deng20698892017-01-25 12:14:33 +0800[diff] [blame]113Chinese translations
114--------------------
115
116.. toctree::
117 :maxdepth: 1
118
119 translations/zh_CN/index
120
Tsugikazu Shibataf0127332017-04-08 12:24:04 +0200[diff] [blame]121Japanese translations
122---------------------
123
124.. toctree::
125 :maxdepth: 1
126
127 translations/ja_JP/index
128
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]129Indices and tables
130==================
131
132* :ref:`genindex`