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