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