Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / kernel / shift / mainline / 08a69058c02f9588775360c8703e69fc0ec4626c / . / Documentation / index.rst
blob: 68ae2a4d689dc6993b8235fb37060cf4153562f5 [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
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300[diff] [blame]38 kbuild/index
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]39
Changbin Du680e6ff2019-04-25 23:30:54 +0800[diff] [blame]40Firmware-related documentation
41------------------------------
42The following holds information on the kernel's expectations regarding the
43platform firmwares.
44
45.. toctree::
46 :maxdepth: 2
47
48 firmware-guide/index
49
Jonathan Corbet1d596de2017-04-02 14:58:01 -0600[diff] [blame]50Application-developer documentation
51-----------------------------------
52
53The user-space API manual gathers together documents describing aspects of
54the kernel interface as seen by application developers.
55
56.. toctree::
57 :maxdepth: 2
58
Mike Rapoport82381912018-03-21 21:22:48 +0200[diff] [blame]59 userspace-api/index
Mauro Carvalho Chehab616b81d2019-06-18 17:13:24 -0300[diff] [blame]60 ioctl/index
Jonathan Corbet1d596de2017-04-02 14:58:01 -0600[diff] [blame]61
62
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]63Introduction to kernel development
64----------------------------------
65
66These manuals contain overall information about how to develop the kernel.
67The kernel community is quite large, with thousands of developers
68contributing over the course of a year. As with any large community,
69knowing how things are done will make the process of getting your changes
70merged much easier.
71
72.. toctree::
73 :maxdepth: 2
74
Mauro Carvalho Chehab0e4f07a2016-10-18 09:05:32 -0200[diff] [blame]75 process/index
Markus Heiserc2893122016-10-26 08:23:14 +0200[diff] [blame]76 dev-tools/index
Mauro Carvalho Chehab1dc4bbf2016-11-17 08:32:33 -0200[diff] [blame]77 doc-guide/index
Mauro Carvalho Chehabc4fcd7c2017-05-11 08:03:27 -0300[diff] [blame]78 kernel-hacking/index
Changbin Du583bc6b2018-02-17 13:39:34 +0800[diff] [blame]79 trace/index
Tobin C. Harding9727a012017-12-04 10:27:29 +1100[diff] [blame]80 maintainer/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300[diff] [blame]81 fault-injection/index
82 livepatch/index
83
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]84
85Kernel API documentation
86------------------------
87
88These books get into the details of how specific kernel subsystems work
89from the point of view of a kernel developer. Much of the information here
90is taken directly from the kernel source, with supplemental material added
91as 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]92needed).
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]93
94.. toctree::
95 :maxdepth: 2
96
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]97 driver-api/index
Silvio Fricke24755a52016-10-28 10:14:10 +0200[diff] [blame]98 core-api/index
Mauro Carvalho Chehab4c680602019-06-28 07:29:15 -0300[diff] [blame]99 locking/index
Mauro Carvalho Chehabdf1b7ce2019-06-18 17:16:23 -0300[diff] [blame]100 accounting/index
101 block/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300[diff] [blame]102 cdrom/index
103 ide/index
104 fb/index
105 fpga/index
Mauro Carvalho Chehabdf1b7ce2019-06-18 17:16:23 -0300[diff] [blame]106 hid/index
107 iio/index
Mauro Carvalho Chehaba3a400d2019-06-28 09:30:28 -0300[diff] [blame]108 infiniband/index
Mauro Carvalho Chehab09fdc952019-06-18 16:51:34 -0300[diff] [blame]109 leds/index
Markus Heiserb32feba2016-08-13 16:12:43 +0200[diff] [blame]110 media/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300[diff] [blame]111 netlabel/index
Mauro Carvalho Chehab05e0f3b2017-05-12 09:14:02 -0300[diff] [blame]112 networking/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300[diff] [blame]113 pcmcia/index
Mauro Carvalho Chehab08a69052019-07-15 09:39:57 -0300[diff] [blame^]114 power/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300[diff] [blame]115 target/index
116 timers/index
117 watchdog/index
Mauro Carvalho Chehabaeb899a2017-04-11 07:01:19 -0300[diff] [blame]118 input/index
Mauro Carvalho Chehab7ebd8b662019-04-17 06:46:29 -0300[diff] [blame]119 hwmon/index
Jani Nikulacb597fc2016-06-21 14:48:57 +0300[diff] [blame]120 gpu/index
Jarkko Sakkinen799a5452016-11-03 17:57:52 -0600[diff] [blame]121 security/index
Takashi Iwai85519142016-11-02 21:30:39 +0100[diff] [blame]122 sound/index
Stephan Mueller3b72c812016-10-21 04:54:22 +0200[diff] [blame]123 crypto/index
Mauro Carvalho Chehab90f9f112017-05-12 06:50:22 -0300[diff] [blame]124 filesystems/index
Mike Rapoport82381912018-03-21 21:22:48 +0200[diff] [blame]125 vm/index
Tobin C. Harding32095702018-07-26 15:03:04 +1000[diff] [blame]126 bpf/index
Mauro Carvalho Chehabecefae62019-06-18 18:05:38 -0300[diff] [blame]127 usb/index
Changbin Duc42eaff2019-05-14 22:47:23 +0800[diff] [blame]128 PCI/index
Randy Dunlap5591a302019-01-13 19:21:46 -0800[diff] [blame]129 misc-devices/index
Mauro Carvalho Chehabc92992f2019-04-22 16:49:11 -0300[diff] [blame]130 mic/index
Mauro Carvalho Chehabc92992f2019-04-22 16:49:11 -0300[diff] [blame]131 scheduler/index
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]132
Mauro Carvalho Chehabbffac832017-05-13 07:50:43 -0300[diff] [blame]133Architecture-specific documentation
134-----------------------------------
135
136These books provide programming details about architecture-specific
137implementation.
138
139.. toctree::
140 :maxdepth: 2
141
142 sh/index
Mauro Carvalho Chehab159a5e72019-04-22 16:10:26 -0300[diff] [blame]143 arm/index
144 arm64/index
145 ia64/index
146 m68k/index
Mauro Carvalho Chehab4d2e26a2019-04-10 08:32:42 -0300[diff] [blame]147 powerpc/index
Mauro Carvalho Chehab159a5e72019-04-22 16:10:26 -0300[diff] [blame]148 riscv/index
149 s390/index
150 sh/index
151 sparc/index
Thomas Gleixner6a9e5292019-02-18 23:13:06 +0100[diff] [blame]152 x86/index
Mauro Carvalho Chehab159a5e72019-04-22 16:10:26 -0300[diff] [blame]153 xtensa/index
Mauro Carvalho Chehabbffac832017-05-13 07:50:43 -0300[diff] [blame]154
Darrick J. Wong66848742018-07-29 16:14:02 -0400[diff] [blame]155Filesystem Documentation
156------------------------
157
158The documentation in this section are provided by specific filesystem
159subprojects.
160
161.. toctree::
Theodore Ts'o0694f8c2018-07-29 16:35:23 -0400[diff] [blame]162 :maxdepth: 2
Darrick J. Wong66848742018-07-29 16:14:02 -0400[diff] [blame]163
164 filesystems/ext4/index
165
Federico Vaga85c32d92018-06-06 00:49:00 +0200[diff] [blame]166Translations
167------------
SeongJae Parkba42c572016-11-08 21:26:09 +0900[diff] [blame]168
169.. toctree::
Federico Vaga85c32d92018-06-06 00:49:00 +0200[diff] [blame]170 :maxdepth: 2
SeongJae Parkba42c572016-11-08 21:26:09 +0900[diff] [blame]171
Federico Vaga85c32d92018-06-06 00:49:00 +0200[diff] [blame]172 translations/index
Tsugikazu Shibataf0127332017-04-08 12:24:04 +0200[diff] [blame]173
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]174Indices and tables
175==================
176
177* :ref:`genindex`