]>
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 |
616b81db | 59 | ioctl/index |
1d596dee JC |
60 | |
61 | ||
b51208d4 JC |
62 | Introduction to kernel development |
63 | ---------------------------------- | |
64 | ||
65 | These manuals contain overall information about how to develop the kernel. | |
66 | The kernel community is quite large, with thousands of developers | |
67 | contributing over the course of a year. As with any large community, | |
68 | knowing how things are done will make the process of getting your changes | |
69 | merged much easier. | |
70 | ||
71 | .. toctree:: | |
72 | :maxdepth: 2 | |
73 | ||
0e4f07a6 | 74 | process/index |
c289312f | 75 | dev-tools/index |
1dc4bbf0 | 76 | doc-guide/index |
c4fcd7ca | 77 | kernel-hacking/index |
583bc6ba | 78 | trace/index |
9727a014 | 79 | maintainer/index |
b51208d4 JC |
80 | |
81 | Kernel API documentation | |
82 | ------------------------ | |
83 | ||
84 | These books get into the details of how specific kernel subsystems work | |
85 | from the point of view of a kernel developer. Much of the information here | |
86 | is taken directly from the kernel source, with supplemental material added | |
87 | as needed (or at least as we managed to add it — probably *not* all that is | |
2069889f | 88 | needed). |
b51208d4 JC |
89 | |
90 | .. toctree:: | |
91 | :maxdepth: 2 | |
92 | ||
dcec3c8c | 93 | driver-api/index |
24755a55 | 94 | core-api/index |
df1b7ce7 MCC |
95 | accounting/index |
96 | block/index | |
97 | hid/index | |
98 | iio/index | |
09fdc957 | 99 | leds/index |
b32febad | 100 | media/index |
05e0f3b9 | 101 | networking/index |
aeb899af | 102 | input/index |
7ebd8b66 | 103 | hwmon/index |
cb597fce | 104 | gpu/index |
799a545b | 105 | security/index |
8551914a | 106 | sound/index |
3b72c814 | 107 | crypto/index |
90f9f118 | 108 | filesystems/index |
82381918 | 109 | vm/index |
3209570d | 110 | bpf/index |
ecefae6d | 111 | usb/index |
5591a307 | 112 | misc-devices/index |
22cba31b | 113 | |
bffac837 MCC |
114 | Architecture-specific documentation |
115 | ----------------------------------- | |
116 | ||
117 | These books provide programming details about architecture-specific | |
118 | implementation. | |
119 | ||
120 | .. toctree:: | |
121 | :maxdepth: 2 | |
122 | ||
123 | sh/index | |
159a5e78 MCC |
124 | arm/index |
125 | arm64/index | |
126 | ia64/index | |
127 | m68k/index | |
128 | riscv/index | |
129 | s390/index | |
130 | sh/index | |
131 | sparc/index | |
6a9e5292 | 132 | x86/index |
159a5e78 | 133 | xtensa/index |
bffac837 | 134 | |
6684874a DW |
135 | Filesystem Documentation |
136 | ------------------------ | |
137 | ||
138 | The documentation in this section are provided by specific filesystem | |
139 | subprojects. | |
140 | ||
141 | .. toctree:: | |
0694f8c3 | 142 | :maxdepth: 2 |
6684874a DW |
143 | |
144 | filesystems/ext4/index | |
145 | ||
85c32d9c FV |
146 | Translations |
147 | ------------ | |
2069889f AD |
148 | |
149 | .. toctree:: | |
85c32d9c | 150 | :maxdepth: 2 |
f0127338 | 151 | |
85c32d9c | 152 | translations/index |
f0127338 | 153 | |
22cba31b JN |
154 | Indices and tables |
155 | ================== | |
156 | ||
157 | * :ref:`genindex` |