Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / 05e0f3b9966c4d6ee8e051607e2ede17b06218c4 / . / Documentation / index.rst
blob: 25c4da41da6b02734ccbffca6ffa350ccb773267 [file] [log] [blame]
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]1.. The Linux Kernel documentation master file, created by
2 sphinx-quickstart on Fri Feb 12 13:51:46 2016.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]6Welcome to The Linux Kernel's 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
16User-oriented documentation
17---------------------------
18
19The following manuals are written for *users* of the kernel — those who are
20trying to get it to work optimally on a given system.
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]21
22.. toctree::
23 :maxdepth: 2
24
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]25 admin-guide/index
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]26
Jonathan Corbet1d596de2017-04-02 14:58:01 -0600[diff] [blame]27Application-developer documentation
28-----------------------------------
29
30The user-space API manual gathers together documents describing aspects of
31the kernel interface as seen by application developers.
32
33.. toctree::
34 :maxdepth: 2
35
36 userspace-api/index
37
38
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]39Introduction to kernel development
40----------------------------------
41
42These manuals contain overall information about how to develop the kernel.
43The kernel community is quite large, with thousands of developers
44contributing over the course of a year. As with any large community,
45knowing how things are done will make the process of getting your changes
46merged much easier.
47
48.. toctree::
49 :maxdepth: 2
50
Mauro Carvalho Chehab0e4f07a2016-10-18 09:05:32 -0200[diff] [blame]51 process/index
Markus Heiserc2893122016-10-26 08:23:14 +0200[diff] [blame]52 dev-tools/index
Mauro Carvalho Chehab1dc4bbf2016-11-17 08:32:33 -0200[diff] [blame]53 doc-guide/index
Mauro Carvalho Chehabc4fcd7c2017-05-11 08:03:27 -0300[diff] [blame]54 kernel-hacking/index
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]55
56Kernel API documentation
57------------------------
58
59These books get into the details of how specific kernel subsystems work
60from the point of view of a kernel developer. Much of the information here
61is taken directly from the kernel source, with supplemental material added
62as 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]63needed).
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]64
65.. toctree::
66 :maxdepth: 2
67
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]68 driver-api/index
Silvio Fricke24755a52016-10-28 10:14:10 +0200[diff] [blame]69 core-api/index
Markus Heiserb32feba2016-08-13 16:12:43 +0200[diff] [blame]70 media/index
Mauro Carvalho Chehab05e0f3b2017-05-12 09:14:02 -0300[diff] [blame^]71 networking/index
Mauro Carvalho Chehabaeb899a2017-04-11 07:01:19 -0300[diff] [blame]72 input/index
Jani Nikulacb597fc2016-06-21 14:48:57 +0300[diff] [blame]73 gpu/index
Jarkko Sakkinen799a5452016-11-03 17:57:52 -0600[diff] [blame]74 security/index
Takashi Iwai85519142016-11-02 21:30:39 +0100[diff] [blame]75 sound/index
Stephan Mueller3b72c812016-10-21 04:54:22 +0200[diff] [blame]76 crypto/index
Mauro Carvalho Chehab90f9f112017-05-12 06:50:22 -0300[diff] [blame]77 filesystems/index
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]78
SeongJae Parkba42c572016-11-08 21:26:09 +0900[diff] [blame]79Korean translations
80-------------------
81
82.. toctree::
83 :maxdepth: 1
84
85 translations/ko_KR/index
86
Andy Deng20698892017-01-25 12:14:33 +0800[diff] [blame]87Chinese translations
88--------------------
89
90.. toctree::
91 :maxdepth: 1
92
93 translations/zh_CN/index
94
Tsugikazu Shibataf0127332017-04-08 12:24:04 +0200[diff] [blame]95Japanese translations
96---------------------
97
98.. toctree::
99 :maxdepth: 1
100
101 translations/ja_JP/index
102
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]103Indices and tables
104==================
105
106* :ref:`genindex`