Google Git
Sign in
cos / third_party / kernel / 8f1ed7554eff45bf08c26fd7f15bc57a7ffac0b0 / . / Documentation / index.rst
blob: 9dfdc826618c08f5f62f81f1cea543dea3223967 [file] [log] [blame]
Mauro Carvalho Chehab4ef7f572020-04-15 16:45:15 +0200[diff] [blame]1.. SPDX-License-Identifier: GPL-2.0
2
Federico Vagaaa586e2572018-06-06 00:49:01 +0200[diff] [blame]3.. _linux_doc:
4
Randy Dunlapb8885e22023-02-14 16:57:26 -0800[diff] [blame]5==============================
Konstantin Ryabitsev61ca5fd2017-06-06 16:50:04 -0400[diff] [blame]6The Linux Kernel documentation
7==============================
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]8
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]9This is the top level of the kernel's documentation tree. Kernel
10documentation, like the kernel itself, is very much a work in progress;
11that is especially true as we work to integrate our many scattered
12documents into a coherent whole. Please note that improvements to the
13documentation are welcome; join the linux-doc list at vger.kernel.org if
14you want to help out.
15
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]16Working with the development community
Randy Dunlapb8885e22023-02-14 16:57:26 -0800[diff] [blame]17======================================
Thomas Gleixneraa19a172017-12-28 23:17:17 +0100[diff] [blame]18
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]19The essential guides for interacting with the kernel's development
20community and getting your work upstream.
Thomas Gleixneraa19a172017-12-28 23:17:17 +0100[diff] [blame]21
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]22.. toctree::
23 :maxdepth: 1
24
25 process/development-process
26 process/submitting-patches
27 Code of conduct <process/code-of-conduct>
28 maintainer/index
29 All development-process docs <process/index>
30
31
32Internal API manuals
Randy Dunlapb8885e22023-02-14 16:57:26 -0800[diff] [blame]33====================
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]34
35Manuals for use by developers working to interface with the rest of the
36kernel.
37
38.. toctree::
39 :maxdepth: 1
40
41 core-api/index
42 driver-api/index
43 subsystem-apis
44 Locking in the kernel <locking/index>
45
46Development tools and processes
Randy Dunlapb8885e22023-02-14 16:57:26 -0800[diff] [blame]47===============================
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]48
49Various other manuals with useful information for all kernel developers.
50
51.. toctree::
52 :maxdepth: 1
53
54 process/license-rules
55 doc-guide/index
56 dev-tools/index
57 dev-tools/testing-overview
58 kernel-hacking/index
59 trace/index
60 fault-injection/index
61 livepatch/index
Linus Torvalds8aebac82022-10-03 16:39:37 -0700[diff] [blame]62 rust/index
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]63
Thomas Gleixneraa19a172017-12-28 23:17:17 +0100[diff] [blame]64
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]65User-oriented documentation
Randy Dunlapb8885e22023-02-14 16:57:26 -0800[diff] [blame]66===========================
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]67
68The following manuals are written for *users* of the kernel — those who are
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]69trying to get it to work optimally on a given system and application
70developers seeking information on the kernel's user-space APIs.
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]71
72.. toctree::
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]73 :maxdepth: 1
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]74
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]75 admin-guide/index
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]76 The kernel build system <kbuild/index>
77 admin-guide/reporting-issues.rst
78 User-space tools <tools/index>
79 userspace-api/index
80
Jonathan Corbet48987602022-09-27 10:05:59 -0600[diff] [blame]81See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_,
82which are kept separately from the kernel's own documentation.
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]83
Changbin Du680e6ff2019-04-25 23:30:54 +0800[diff] [blame]84Firmware-related documentation
Randy Dunlapb8885e22023-02-14 16:57:26 -0800[diff] [blame]85==============================
Changbin Du680e6ff2019-04-25 23:30:54 +0800[diff] [blame]86The following holds information on the kernel's expectations regarding the
87platform firmwares.
88
89.. toctree::
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]90 :maxdepth: 1
Changbin Du680e6ff2019-04-25 23:30:54 +0800[diff] [blame]91
92 firmware-guide/index
Mauro Carvalho Chehab4ef7f572020-04-15 16:45:15 +0200[diff] [blame]93 devicetree/index
Changbin Du680e6ff2019-04-25 23:30:54 +0800[diff] [blame]94
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]95
Mauro Carvalho Chehabbffac832017-05-13 07:50:43 -0300[diff] [blame]96Architecture-specific documentation
Randy Dunlapb8885e22023-02-14 16:57:26 -0800[diff] [blame]97===================================
Mauro Carvalho Chehabbffac832017-05-13 07:50:43 -0300[diff] [blame]98
Mauro Carvalho Chehabbffac832017-05-13 07:50:43 -0300[diff] [blame]99.. toctree::
100 :maxdepth: 2
101
Jonathan Corbet4f1bb032023-03-14 16:39:37 -0600[diff] [blame]102 arch/index
Jonathan Neuschäfer3eca1cf2021-03-12 16:28:03 +0100[diff] [blame]103
Mauro Carvalho Chehabbffac832017-05-13 07:50:43 -0300[diff] [blame]104
Mauro Carvalho Chehab8e2a46a2020-06-15 08:50:25 +0200[diff] [blame]105Other documentation
Randy Dunlapb8885e22023-02-14 16:57:26 -0800[diff] [blame]106===================
Mauro Carvalho Chehab8e2a46a2020-06-15 08:50:25 +0200[diff] [blame]107
108There are several unsorted documents that don't seem to fit on other parts
109of the documentation body, or may require some adjustments and/or conversion
110to ReStructured Text format, or are simply too old.
111
112.. toctree::
Jonathan Corbet0c7b4362022-09-27 10:05:54 -0600[diff] [blame]113 :maxdepth: 1
Mauro Carvalho Chehab8e2a46a2020-06-15 08:50:25 +0200[diff] [blame]114
115 staging/index
116
117
Federico Vaga85c32d92018-06-06 00:49:00 +0200[diff] [blame]118Translations
Randy Dunlapb8885e22023-02-14 16:57:26 -0800[diff] [blame]119============
SeongJae Parkba42c572016-11-08 21:26:09 +0900[diff] [blame]120
121.. toctree::
Federico Vaga85c32d92018-06-06 00:49:00 +0200[diff] [blame]122 :maxdepth: 2
SeongJae Parkba42c572016-11-08 21:26:09 +0900[diff] [blame]123
Federico Vaga85c32d92018-06-06 00:49:00 +0200[diff] [blame]124 translations/index
Tsugikazu Shibataf0127332017-04-08 12:24:04 +0200[diff] [blame]125
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]126Indices and tables
127==================
128
129* :ref:`genindex`