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