]>
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 | ||
9799445a | 25 | * :ref:`kernel_licensing` |
aa19a176 | 26 | |
b51208d4 JC |
27 | User-oriented documentation |
28 | --------------------------- | |
29 | ||
30 | The following manuals are written for *users* of the kernel — those who are | |
31 | trying to get it to work optimally on a given system. | |
22cba31b JN |
32 | |
33 | .. toctree:: | |
34 | :maxdepth: 2 | |
35 | ||
9d85025b | 36 | admin-guide/index |
b51208d4 | 37 | |
680e6ffa CD |
38 | Firmware-related documentation |
39 | ------------------------------ | |
40 | The following holds information on the kernel's expectations regarding the | |
41 | platform firmwares. | |
42 | ||
43 | .. toctree:: | |
44 | :maxdepth: 2 | |
45 | ||
46 | firmware-guide/index | |
47 | ||
1d596dee JC |
48 | Application-developer documentation |
49 | ----------------------------------- | |
50 | ||
51 | The user-space API manual gathers together documents describing aspects of | |
52 | the kernel interface as seen by application developers. | |
53 | ||
54 | .. toctree:: | |
55 | :maxdepth: 2 | |
56 | ||
82381918 | 57 | userspace-api/index |
1d596dee JC |
58 | |
59 | ||
b51208d4 JC |
60 | Introduction to kernel development |
61 | ---------------------------------- | |
62 | ||
63 | These manuals contain overall information about how to develop the kernel. | |
64 | The kernel community is quite large, with thousands of developers | |
65 | contributing over the course of a year. As with any large community, | |
66 | knowing how things are done will make the process of getting your changes | |
67 | merged much easier. | |
68 | ||
69 | .. toctree:: | |
70 | :maxdepth: 2 | |
71 | ||
0e4f07a6 | 72 | process/index |
c289312f | 73 | dev-tools/index |
1dc4bbf0 | 74 | doc-guide/index |
c4fcd7ca | 75 | kernel-hacking/index |
583bc6ba | 76 | trace/index |
9727a014 | 77 | maintainer/index |
b51208d4 JC |
78 | |
79 | Kernel API documentation | |
80 | ------------------------ | |
81 | ||
82 | These books get into the details of how specific kernel subsystems work | |
83 | from the point of view of a kernel developer. Much of the information here | |
84 | is taken directly from the kernel source, with supplemental material added | |
85 | as needed (or at least as we managed to add it — probably *not* all that is | |
2069889f | 86 | needed). |
b51208d4 JC |
87 | |
88 | .. toctree:: | |
89 | :maxdepth: 2 | |
90 | ||
dcec3c8c | 91 | driver-api/index |
24755a55 | 92 | core-api/index |
b32febad | 93 | media/index |
05e0f3b9 | 94 | networking/index |
aeb899af | 95 | input/index |
7ebd8b66 | 96 | hwmon/index |
cb597fce | 97 | gpu/index |
799a545b | 98 | security/index |
8551914a | 99 | sound/index |
3b72c814 | 100 | crypto/index |
90f9f118 | 101 | filesystems/index |
82381918 | 102 | vm/index |
3209570d | 103 | bpf/index |
5591a307 | 104 | misc-devices/index |
22cba31b | 105 | |
bffac837 MCC |
106 | Architecture-specific documentation |
107 | ----------------------------------- | |
108 | ||
109 | These books provide programming details about architecture-specific | |
110 | implementation. | |
111 | ||
112 | .. toctree:: | |
113 | :maxdepth: 2 | |
114 | ||
e5def4c6 | 115 | x86/index |
bffac837 | 116 | sh/index |
6a9e5292 | 117 | x86/index |
bffac837 | 118 | |
6684874a DW |
119 | Filesystem Documentation |
120 | ------------------------ | |
121 | ||
122 | The documentation in this section are provided by specific filesystem | |
123 | subprojects. | |
124 | ||
125 | .. toctree:: | |
0694f8c3 | 126 | :maxdepth: 2 |
6684874a DW |
127 | |
128 | filesystems/ext4/index | |
129 | ||
85c32d9c FV |
130 | Translations |
131 | ------------ | |
2069889f AD |
132 | |
133 | .. toctree:: | |
85c32d9c | 134 | :maxdepth: 2 |
f0127338 | 135 | |
85c32d9c | 136 | translations/index |
f0127338 | 137 | |
22cba31b JN |
138 | Indices and tables |
139 | ================== | |
140 | ||
141 | * :ref:`genindex` |