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