]>
Commit | Line | Data |
---|---|---|
22cba31b JN |
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 | ||
61ca5fd1 KR |
6 | The Linux Kernel documentation |
7 | ============================== | |
22cba31b | 8 | |
b51208d4 JC |
9 | This is the top level of the kernel's documentation tree. Kernel |
10 | documentation, like the kernel itself, is very much a work in progress; | |
11 | that is especially true as we work to integrate our many scattered | |
12 | documents into a coherent whole. Please note that improvements to the | |
13 | documentation are welcome; join the linux-doc list at vger.kernel.org if | |
14 | you want to help out. | |
15 | ||
16 | User-oriented documentation | |
17 | --------------------------- | |
18 | ||
19 | The following manuals are written for *users* of the kernel — those who are | |
20 | trying to get it to work optimally on a given system. | |
22cba31b JN |
21 | |
22 | .. toctree:: | |
23 | :maxdepth: 2 | |
24 | ||
9d85025b | 25 | admin-guide/index |
b51208d4 | 26 | |
1d596dee JC |
27 | Application-developer documentation |
28 | ----------------------------------- | |
29 | ||
30 | The user-space API manual gathers together documents describing aspects of | |
31 | the kernel interface as seen by application developers. | |
32 | ||
33 | .. toctree:: | |
34 | :maxdepth: 2 | |
35 | ||
36 | userspace-api/index | |
37 | ||
38 | ||
b51208d4 JC |
39 | Introduction to kernel development |
40 | ---------------------------------- | |
41 | ||
42 | These manuals contain overall information about how to develop the kernel. | |
43 | The kernel community is quite large, with thousands of developers | |
44 | contributing over the course of a year. As with any large community, | |
45 | knowing how things are done will make the process of getting your changes | |
46 | merged much easier. | |
47 | ||
48 | .. toctree:: | |
49 | :maxdepth: 2 | |
50 | ||
0e4f07a6 | 51 | process/index |
c289312f | 52 | dev-tools/index |
1dc4bbf0 | 53 | doc-guide/index |
c4fcd7ca | 54 | kernel-hacking/index |
b51208d4 JC |
55 | |
56 | Kernel API documentation | |
57 | ------------------------ | |
58 | ||
59 | These books get into the details of how specific kernel subsystems work | |
60 | from the point of view of a kernel developer. Much of the information here | |
61 | is taken directly from the kernel source, with supplemental material added | |
62 | as needed (or at least as we managed to add it — probably *not* all that is | |
2069889f | 63 | needed). |
b51208d4 JC |
64 | |
65 | .. toctree:: | |
66 | :maxdepth: 2 | |
67 | ||
dcec3c8c | 68 | driver-api/index |
24755a55 | 69 | core-api/index |
b32febad | 70 | media/index |
05e0f3b9 | 71 | networking/index |
aeb899af | 72 | input/index |
cb597fce | 73 | gpu/index |
799a545b | 74 | security/index |
8551914a | 75 | sound/index |
3b72c814 | 76 | crypto/index |
90f9f118 | 77 | filesystems/index |
22cba31b | 78 | |
bffac837 MCC |
79 | Architecture-specific documentation |
80 | ----------------------------------- | |
81 | ||
82 | These books provide programming details about architecture-specific | |
83 | implementation. | |
84 | ||
85 | .. toctree:: | |
86 | :maxdepth: 2 | |
87 | ||
88 | sh/index | |
4446d382 | 89 | x86/index |
bffac837 | 90 | |
ba42c574 SP |
91 | Korean translations |
92 | ------------------- | |
93 | ||
94 | .. toctree:: | |
95 | :maxdepth: 1 | |
96 | ||
97 | translations/ko_KR/index | |
98 | ||
2069889f AD |
99 | Chinese translations |
100 | -------------------- | |
101 | ||
102 | .. toctree:: | |
103 | :maxdepth: 1 | |
104 | ||
105 | translations/zh_CN/index | |
106 | ||
f0127338 TS |
107 | Japanese translations |
108 | --------------------- | |
109 | ||
110 | .. toctree:: | |
111 | :maxdepth: 1 | |
112 | ||
113 | translations/ja_JP/index | |
114 | ||
22cba31b JN |
115 | Indices and tables |
116 | ================== | |
117 | ||
118 | * :ref:`genindex` |