Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / kernel / common / 80f232121b69cc69a31ccb2b38c1665d770b0710 / . / Documentation / index.rst
blob: fec80fee512a820497874ca7e6cc6efb42261cf3 [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
Federico Vagaaa586e22018-06-06 00:49:01 +0200[diff] [blame]6.. _linux_doc:
7
Konstantin Ryabitsev61ca5fd2017-06-06 16:50:04 -0400[diff] [blame]8The Linux Kernel documentation
9==============================
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]10
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]11This is the top level of the kernel's documentation tree. Kernel
12documentation, like the kernel itself, is very much a work in progress;
13that is especially true as we work to integrate our many scattered
14documents into a coherent whole. Please note that improvements to the
15documentation are welcome; join the linux-doc list at vger.kernel.org if
16you want to help out.
17
Thomas Gleixneraa19a172017-12-28 23:17:17 +0100[diff] [blame]18Licensing documentation
19-----------------------
20
21The following describes the license of the Linux kernel source code
22(GPLv2), how to properly mark the license of individual files in the source
23tree, as well as links to the full license text.
24
Markus Heiser97994452018-08-14 13:43:12 +0200[diff] [blame]25* :ref:`kernel_licensing`
Thomas Gleixneraa19a172017-12-28 23:17:17 +0100[diff] [blame]26
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]27User-oriented documentation
28---------------------------
29
30The following manuals are written for *users* of the kernel — those who are
31trying to get it to work optimally on a given system.
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]32
33.. toctree::
34 :maxdepth: 2
35
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]36 admin-guide/index
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]37
Changbin Du680e6ff2019-04-25 23:30:54 +0800[diff] [blame]38Firmware-related documentation
39------------------------------
40The following holds information on the kernel's expectations regarding the
41platform firmwares.
42
43.. toctree::
44 :maxdepth: 2
45
46 firmware-guide/index
47
Jonathan Corbet1d596de2017-04-02 14:58:01 -0600[diff] [blame]48Application-developer documentation
49-----------------------------------
50
51The user-space API manual gathers together documents describing aspects of
52the kernel interface as seen by application developers.
53
54.. toctree::
55 :maxdepth: 2
56
Mike Rapoport82381912018-03-21 21:22:48 +0200[diff] [blame]57 userspace-api/index
Jonathan Corbet1d596de2017-04-02 14:58:01 -0600[diff] [blame]58
59
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]60Introduction to kernel development
61----------------------------------
62
63These manuals contain overall information about how to develop the kernel.
64The kernel community is quite large, with thousands of developers
65contributing over the course of a year. As with any large community,
66knowing how things are done will make the process of getting your changes
67merged much easier.
68
69.. toctree::
70 :maxdepth: 2
71
Mauro Carvalho Chehab0e4f07a2016-10-18 09:05:32 -0200[diff] [blame]72 process/index
Markus Heiserc2893122016-10-26 08:23:14 +0200[diff] [blame]73 dev-tools/index
Mauro Carvalho Chehab1dc4bbf2016-11-17 08:32:33 -0200[diff] [blame]74 doc-guide/index
Mauro Carvalho Chehabc4fcd7c2017-05-11 08:03:27 -0300[diff] [blame]75 kernel-hacking/index
Changbin Du583bc6b2018-02-17 13:39:34 +0800[diff] [blame]76 trace/index
Tobin C. Harding9727a012017-12-04 10:27:29 +1100[diff] [blame]77 maintainer/index
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]78
79Kernel API documentation
80------------------------
81
82These books get into the details of how specific kernel subsystems work
83from the point of view of a kernel developer. Much of the information here
84is taken directly from the kernel source, with supplemental material added
85as 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]86needed).
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]87
88.. toctree::
89 :maxdepth: 2
90
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]91 driver-api/index
Silvio Fricke24755a52016-10-28 10:14:10 +0200[diff] [blame]92 core-api/index
Markus Heiserb32feba2016-08-13 16:12:43 +0200[diff] [blame]93 media/index
Mauro Carvalho Chehab05e0f3b2017-05-12 09:14:02 -0300[diff] [blame]94 networking/index
Mauro Carvalho Chehabaeb899a2017-04-11 07:01:19 -0300[diff] [blame]95 input/index
Mauro Carvalho Chehab7ebd8b662019-04-17 06:46:29 -0300[diff] [blame]96 hwmon/index
Jani Nikulacb597fc2016-06-21 14:48:57 +0300[diff] [blame]97 gpu/index
Jarkko Sakkinen799a5452016-11-03 17:57:52 -0600[diff] [blame]98 security/index
Takashi Iwai85519142016-11-02 21:30:39 +0100[diff] [blame]99 sound/index
Stephan Mueller3b72c812016-10-21 04:54:22 +0200[diff] [blame]100 crypto/index
Mauro Carvalho Chehab90f9f112017-05-12 06:50:22 -0300[diff] [blame]101 filesystems/index
Mike Rapoport82381912018-03-21 21:22:48 +0200[diff] [blame]102 vm/index
Tobin C. Harding32095702018-07-26 15:03:04 +1000[diff] [blame]103 bpf/index
Randy Dunlap5591a302019-01-13 19:21:46 -0800[diff] [blame]104 misc-devices/index
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]105
Mauro Carvalho Chehabbffac832017-05-13 07:50:43 -0300[diff] [blame]106Architecture-specific documentation
107-----------------------------------
108
109These books provide programming details about architecture-specific
110implementation.
111
112.. toctree::
113 :maxdepth: 2
114
115 sh/index
116
Darrick J. Wong66848742018-07-29 16:14:02 -0400[diff] [blame]117Filesystem Documentation
118------------------------
119
120The documentation in this section are provided by specific filesystem
121subprojects.
122
123.. toctree::
Theodore Ts'o0694f8c2018-07-29 16:35:23 -0400[diff] [blame]124 :maxdepth: 2
Darrick J. Wong66848742018-07-29 16:14:02 -0400[diff] [blame]125
126 filesystems/ext4/index
127
Federico Vaga85c32d92018-06-06 00:49:00 +0200[diff] [blame]128Translations
129------------
SeongJae Parkba42c572016-11-08 21:26:09 +0900[diff] [blame]130
131.. toctree::
Federico Vaga85c32d92018-06-06 00:49:00 +0200[diff] [blame]132 :maxdepth: 2
SeongJae Parkba42c572016-11-08 21:26:09 +0900[diff] [blame]133
Federico Vaga85c32d92018-06-06 00:49:00 +0200[diff] [blame]134 translations/index
Tsugikazu Shibataf0127332017-04-08 12:24:04 +0200[diff] [blame]135
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]136Indices and tables
137==================
138
139* :ref:`genindex`