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