blob: d39fd2c9f1ceea29c42a6886005cb73744855ef3 [file] [log] [blame]
Mauro Carvalho Chehabdc7a12b2019-04-14 15:51:10 -03001
Jani Nikula22cba312016-05-19 15:14:05 +03002.. 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 +02007.. _linux_doc:
8
Konstantin Ryabitsev61ca5fd2017-06-06 16:50:04 -04009The Linux Kernel documentation
10==============================
Jani Nikula22cba312016-05-19 15:14:05 +030011
Jonathan Corbetb51208d2016-10-26 15:43:00 -060012This 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 +010019Licensing 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 +020026* :ref:`kernel_licensing`
Thomas Gleixneraa19a172017-12-28 23:17:17 +010027
Jonathan Corbetb51208d2016-10-26 15:43:00 -060028User-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 +030033
34.. toctree::
35 :maxdepth: 2
36
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -030037 admin-guide/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -030038 kbuild/index
Jonathan Corbetb51208d2016-10-26 15:43:00 -060039
Changbin Du680e6ff2019-04-25 23:30:54 +080040Firmware-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 -060050Application-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 +020059 userspace-api/index
Jonathan Corbet1d596de2017-04-02 14:58:01 -060060
61
Jonathan Corbetb51208d2016-10-26 15:43:00 -060062Introduction 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 -020074 process/index
Markus Heiserc2893122016-10-26 08:23:14 +020075 dev-tools/index
Mauro Carvalho Chehab1dc4bbf2016-11-17 08:32:33 -020076 doc-guide/index
Mauro Carvalho Chehabc4fcd7c2017-05-11 08:03:27 -030077 kernel-hacking/index
Changbin Du583bc6b2018-02-17 13:39:34 +080078 trace/index
Tobin C. Harding9727a012017-12-04 10:27:29 +110079 maintainer/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -030080 fault-injection/index
81 livepatch/index
82
Jonathan Corbetb51208d2016-10-26 15:43:00 -060083
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 +080091needed).
Jonathan Corbetb51208d2016-10-26 15:43:00 -060092
93.. toctree::
94 :maxdepth: 2
95
Jonathan Corbetdcec3c82016-08-20 13:17:32 -060096 driver-api/index
Silvio Fricke24755a52016-10-28 10:14:10 +020097 core-api/index
Mauro Carvalho Chehab4c680602019-06-28 07:29:15 -030098 locking/index
Mauro Carvalho Chehabdf1b7ce2019-06-18 17:16:23 -030099 accounting/index
100 block/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300101 cdrom/index
102 ide/index
103 fb/index
104 fpga/index
Mauro Carvalho Chehabdf1b7ce2019-06-18 17:16:23 -0300105 hid/index
Mauro Carvalho Chehabccf988b2019-07-26 09:51:16 -0300106 i2c/index
Mauro Carvalho Chehabdf1b7ce2019-06-18 17:16:23 -0300107 iio/index
Mauro Carvalho Chehab5a5e0452019-07-26 09:51:25 -0300108 isdn/index
Mauro Carvalho Chehaba3a400d2019-06-28 09:30:28 -0300109 infiniband/index
Mauro Carvalho Chehab09fdc952019-06-18 16:51:34 -0300110 leds/index
Markus Heiserb32feba2016-08-13 16:12:43 +0200111 media/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300112 netlabel/index
Mauro Carvalho Chehab05e0f3b2017-05-12 09:14:02 -0300113 networking/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300114 pcmcia/index
Mauro Carvalho Chehab08a69052019-07-15 09:39:57 -0300115 power/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300116 target/index
117 timers/index
Mauro Carvalho Chehab9cdd2732019-07-31 17:08:50 -0300118 spi/index
Mauro Carvalho Chehabe9bb6272019-07-31 17:08:53 -0300119 w1/index
Mauro Carvalho Chehab113094f2019-06-28 08:36:50 -0300120 watchdog/index
Sheriff Esseson03d36522019-08-09 14:23:49 +0100121 virt/index
Mauro Carvalho Chehabaeb899a2017-04-11 07:01:19 -0300122 input/index
Mauro Carvalho Chehab7ebd8b662019-04-17 06:46:29 -0300123 hwmon/index
Jani Nikulacb597fc2016-06-21 14:48:57 +0300124 gpu/index
Jarkko Sakkinen799a5452016-11-03 17:57:52 -0600125 security/index
Takashi Iwai85519142016-11-02 21:30:39 +0100126 sound/index
Stephan Mueller3b72c812016-10-21 04:54:22 +0200127 crypto/index
Mauro Carvalho Chehab90f9f112017-05-12 06:50:22 -0300128 filesystems/index
Mike Rapoport82381912018-03-21 21:22:48 +0200129 vm/index
Tobin C. Harding32095702018-07-26 15:03:04 +1000130 bpf/index
Mauro Carvalho Chehabecefae62019-06-18 18:05:38 -0300131 usb/index
Changbin Duc42eaff2019-05-14 22:47:23 +0800132 PCI/index
Mauro Carvalho Chehab31df2fd2020-03-02 09:15:34 +0100133 scsi/index
Randy Dunlap5591a302019-01-13 19:21:46 -0800134 misc-devices/index
Mauro Carvalho Chehabc92992f2019-04-22 16:49:11 -0300135 mic/index
Mauro Carvalho Chehabc92992f2019-04-22 16:49:11 -0300136 scheduler/index
Jani Nikula22cba312016-05-19 15:14:05 +0300137
Jiri Slabyffedeeb2019-10-11 13:50:41 +0200138Architecture-agnostic documentation
139-----------------------------------
140
141.. toctree::
142 :maxdepth: 2
143
144 asm-annotations
145
Mauro Carvalho Chehabbffac832017-05-13 07:50:43 -0300146Architecture-specific documentation
147-----------------------------------
148
149These books provide programming details about architecture-specific
150implementation.
151
152.. toctree::
153 :maxdepth: 2
154
Mauro Carvalho Chehab159a5e72019-04-22 16:10:26 -0300155 arm/index
156 arm64/index
157 ia64/index
158 m68k/index
Mauro Carvalho Chehab80b15052019-07-26 09:51:31 -0300159 mips/index
Mauro Carvalho Chehab47359e52019-07-26 09:51:33 -0300160 nios2/nios2
Mauro Carvalho Chehab32fc3cd2019-07-26 09:51:24 -0300161 openrisc/index
Mauro Carvalho Chehabe77e9182019-07-26 09:51:23 -0300162 parisc/index
Linus Torvalds5c6bd5d2019-09-22 09:30:30 -0700163 powerpc/index
Mauro Carvalho Chehab159a5e72019-04-22 16:10:26 -0300164 riscv/index
165 s390/index
166 sh/index
167 sparc/index
Thomas Gleixner6a9e5292019-02-18 23:13:06 +0100168 x86/index
Mauro Carvalho Chehab159a5e72019-04-22 16:10:26 -0300169 xtensa/index
Mauro Carvalho Chehabbffac832017-05-13 07:50:43 -0300170
Darrick J. Wong66848742018-07-29 16:14:02 -0400171Filesystem Documentation
172------------------------
173
174The documentation in this section are provided by specific filesystem
175subprojects.
176
177.. toctree::
Theodore Ts'o0694f8c2018-07-29 16:35:23 -0400178 :maxdepth: 2
Darrick J. Wong66848742018-07-29 16:14:02 -0400179
180 filesystems/ext4/index
181
Federico Vaga85c32d92018-06-06 00:49:00 +0200182Translations
183------------
SeongJae Parkba42c572016-11-08 21:26:09 +0900184
185.. toctree::
Federico Vaga85c32d92018-06-06 00:49:00 +0200186 :maxdepth: 2
SeongJae Parkba42c572016-11-08 21:26:09 +0900187
Federico Vaga85c32d92018-06-06 00:49:00 +0200188 translations/index
Tsugikazu Shibataf0127332017-04-08 12:24:04 +0200189
Jani Nikula22cba312016-05-19 15:14:05 +0300190Indices and tables
191==================
192
193* :ref:`genindex`