Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.19 / 18a4208826dd0a13eb06de724c86bba2c225f943 / . / Documentation / index.rst
blob: f6e641a54bbcab5c6dd8e4d8f724c580deaff19e [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
27Introduction to kernel development
28----------------------------------
29
30These manuals contain overall information about how to develop the kernel.
31The kernel community is quite large, with thousands of developers
32contributing over the course of a year. As with any large community,
33knowing how things are done will make the process of getting your changes
34merged much easier.
35
36.. toctree::
37 :maxdepth: 2
38
Mauro Carvalho Chehab0e4f07a2016-10-18 09:05:32 -0200[diff] [blame]39 process/index
Markus Heiserc2893122016-10-26 08:23:14 +0200[diff] [blame]40 dev-tools/index
Mauro Carvalho Chehab1dc4bbf2016-11-17 08:32:33 -0200[diff] [blame]41 doc-guide/index
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]42
43Kernel API documentation
44------------------------
45
46These books get into the details of how specific kernel subsystems work
47from the point of view of a kernel developer. Much of the information here
48is taken directly from the kernel source, with supplemental material added
49as 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]50needed).
Jonathan Corbetb51208d2016-10-26 15:43:00 -0600[diff] [blame]51
52.. toctree::
53 :maxdepth: 2
54
Jonathan Corbetdcec3c82016-08-20 13:17:32 -0600[diff] [blame]55 driver-api/index
Silvio Fricke24755a52016-10-28 10:14:10 +0200[diff] [blame]56 core-api/index
Markus Heiserb32feba2016-08-13 16:12:43 +0200[diff] [blame]57 media/index
Jani Nikulacb597fc2016-06-21 14:48:57 +0300[diff] [blame]58 gpu/index
Jarkko Sakkinen799a5452016-11-03 17:57:52 -0600[diff] [blame]59 security/index
Takashi Iwai85519142016-11-02 21:30:39 +0100[diff] [blame]60 sound/index
Stephan Mueller3b72c812016-10-21 04:54:22 +0200[diff] [blame]61 crypto/index
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]62
SeongJae Parkba42c572016-11-08 21:26:09 +0900[diff] [blame]63Korean translations
64-------------------
65
66.. toctree::
67 :maxdepth: 1
68
69 translations/ko_KR/index
70
Andy Deng20698892017-01-25 12:14:33 +0800[diff] [blame]71Chinese translations
72--------------------
73
74.. toctree::
75 :maxdepth: 1
76
77 translations/zh_CN/index
78
Jani Nikula22cba312016-05-19 15:14:05 +0300[diff] [blame]79Indices and tables
80==================
81
82* :ref:`genindex`