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 | ||
aa19a176 TG |
16 | Licensing documentation |
17 | ----------------------- | |
18 | ||
19 | The following describes the license of the Linux kernel source code | |
20 | (GPLv2), how to properly mark the license of individual files in the source | |
21 | tree, as well as links to the full license text. | |
22 | ||
23 | .. toctree:: | |
24 | :maxdepth: 2 | |
25 | ||
26 | process/license-rules.rst | |
27 | ||
b51208d4 JC |
28 | User-oriented documentation |
29 | --------------------------- | |
30 | ||
31 | The following manuals are written for *users* of the kernel — those who are | |
32 | trying to get it to work optimally on a given system. | |
22cba31b JN |
33 | |
34 | .. toctree:: | |
35 | :maxdepth: 2 | |
36 | ||
9d85025b | 37 | admin-guide/index |
b51208d4 | 38 | |
1d596dee JC |
39 | Application-developer documentation |
40 | ----------------------------------- | |
41 | ||
42 | The user-space API manual gathers together documents describing aspects of | |
43 | the kernel interface as seen by application developers. | |
44 | ||
45 | .. toctree:: | |
46 | :maxdepth: 2 | |
47 | ||
48 | userspace-api/index | |
49 | ||
50 | ||
b51208d4 JC |
51 | Introduction to kernel development |
52 | ---------------------------------- | |
53 | ||
54 | These manuals contain overall information about how to develop the kernel. | |
55 | The kernel community is quite large, with thousands of developers | |
56 | contributing over the course of a year. As with any large community, | |
57 | knowing how things are done will make the process of getting your changes | |
58 | merged much easier. | |
59 | ||
60 | .. toctree:: | |
61 | :maxdepth: 2 | |
62 | ||
0e4f07a6 | 63 | process/index |
c289312f | 64 | dev-tools/index |
1dc4bbf0 | 65 | doc-guide/index |
c4fcd7ca | 66 | kernel-hacking/index |
583bc6ba | 67 | trace/index |
9727a014 | 68 | maintainer/index |
b51208d4 JC |
69 | |
70 | Kernel API documentation | |
71 | ------------------------ | |
72 | ||
73 | These books get into the details of how specific kernel subsystems work | |
74 | from the point of view of a kernel developer. Much of the information here | |
75 | is taken directly from the kernel source, with supplemental material added | |
76 | as needed (or at least as we managed to add it — probably *not* all that is | |
2069889f | 77 | needed). |
b51208d4 JC |
78 | |
79 | .. toctree:: | |
80 | :maxdepth: 2 | |
81 | ||
dcec3c8c | 82 | driver-api/index |
24755a55 | 83 | core-api/index |
b32febad | 84 | media/index |
05e0f3b9 | 85 | networking/index |
aeb899af | 86 | input/index |
cb597fce | 87 | gpu/index |
799a545b | 88 | security/index |
8551914a | 89 | sound/index |
3b72c814 | 90 | crypto/index |
90f9f118 | 91 | filesystems/index |
22cba31b | 92 | |
bffac837 MCC |
93 | Architecture-specific documentation |
94 | ----------------------------------- | |
95 | ||
96 | These books provide programming details about architecture-specific | |
97 | implementation. | |
98 | ||
99 | .. toctree:: | |
100 | :maxdepth: 2 | |
101 | ||
102 | sh/index | |
103 | ||
ba42c574 SP |
104 | Korean translations |
105 | ------------------- | |
106 | ||
107 | .. toctree:: | |
108 | :maxdepth: 1 | |
109 | ||
110 | translations/ko_KR/index | |
111 | ||
2069889f AD |
112 | Chinese translations |
113 | -------------------- | |
114 | ||
115 | .. toctree:: | |
116 | :maxdepth: 1 | |
117 | ||
118 | translations/zh_CN/index | |
119 | ||
f0127338 TS |
120 | Japanese translations |
121 | --------------------- | |
122 | ||
123 | .. toctree:: | |
124 | :maxdepth: 1 | |
125 | ||
126 | translations/ja_JP/index | |
127 | ||
22cba31b JN |
128 | Indices and tables |
129 | ================== | |
130 | ||
131 | * :ref:`genindex` |