]>
Commit | Line | Data |
---|---|---|
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 | ||
6 | Welcome to The Linux Kernel's documentation | |
7 | =========================================== | |
8 | ||
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 | ||
16 | User-oriented documentation | |
17 | --------------------------- | |
18 | ||
19 | The following manuals are written for *users* of the kernel — those who are | |
20 | trying to get it to work optimally on a given system. | |
21 | ||
22 | .. toctree:: | |
23 | :maxdepth: 2 | |
24 | ||
25 | admin-guide/index | |
26 | ||
27 | Introduction to kernel development | |
28 | ---------------------------------- | |
29 | ||
30 | These manuals contain overall information about how to develop the kernel. | |
31 | The kernel community is quite large, with thousands of developers | |
32 | contributing over the course of a year. As with any large community, | |
33 | knowing how things are done will make the process of getting your changes | |
34 | merged much easier. | |
35 | ||
36 | .. toctree:: | |
37 | :maxdepth: 2 | |
38 | ||
39 | process/index | |
40 | dev-tools/index | |
41 | doc-guide/index | |
42 | ||
43 | Kernel API documentation | |
44 | ------------------------ | |
45 | ||
46 | These books get into the details of how specific kernel subsystems work | |
47 | from the point of view of a kernel developer. Much of the information here | |
48 | is taken directly from the kernel source, with supplemental material added | |
49 | as needed (or at least as we managed to add it — probably *not* all that is | |
50 | needed). | |
51 | ||
52 | .. toctree:: | |
53 | :maxdepth: 2 | |
54 | ||
55 | driver-api/index | |
56 | core-api/index | |
57 | media/index | |
58 | gpu/index | |
59 | security/index | |
60 | sound/index | |
61 | crypto/index | |
62 | ||
63 | Korean translations | |
64 | ------------------- | |
65 | ||
66 | .. toctree:: | |
67 | :maxdepth: 1 | |
68 | ||
69 | translations/ko_KR/index | |
70 | ||
71 | Indices and tables | |
72 | ================== | |
73 | ||
74 | * :ref:`genindex` |