projects / mirror_ubuntu-bionic-kernel.git / blame
| 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 | ||
| b51208d4 JC |
6 | Welcome to The Linux Kernel's documentation |
| 7 | =========================================== | |
| 22cba31b | 8 | |
| b51208d4 JC |
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. | |
| 22cba31b JN |
21 | |
| 22 | .. toctree:: | |
| 23 | :maxdepth: 2 | |
| 24 | ||
| 9d85025b | 25 | admin-guide/index |
| b51208d4 | 26 | |
| 1d596dee JC |
27 | Application-developer documentation |
| 28 | ----------------------------------- | |
| 29 | ||
| 30 | The user-space API manual gathers together documents describing aspects of | |
| 31 | the kernel interface as seen by application developers. | |
| 32 | ||
| 33 | .. toctree:: | |
| 34 | :maxdepth: 2 | |
| 35 | ||
| 36 | userspace-api/index | |
| 37 | ||
| 38 | ||
| b51208d4 JC |
39 | Introduction to kernel development |
| 40 | ---------------------------------- | |
| 41 | ||
| 42 | These manuals contain overall information about how to develop the kernel. | |
| 43 | The kernel community is quite large, with thousands of developers | |
| 44 | contributing over the course of a year. As with any large community, | |
| 45 | knowing how things are done will make the process of getting your changes | |
| 46 | merged much easier. | |
| 47 | ||
| 48 | .. toctree:: | |
| 49 | :maxdepth: 2 | |
| 50 | ||
| 0e4f07a6 | 51 | process/index |
| c289312f | 52 | dev-tools/index |
| 1dc4bbf0 | 53 | doc-guide/index |
| b51208d4 JC |
54 | |
| 55 | Kernel API documentation | |
| 56 | ------------------------ | |
| 57 | ||
| 58 | These books get into the details of how specific kernel subsystems work | |
| 59 | from the point of view of a kernel developer. Much of the information here | |
| 60 | is taken directly from the kernel source, with supplemental material added | |
| 61 | as needed (or at least as we managed to add it — probably *not* all that is | |
| 2069889f | 62 | needed). |
| b51208d4 JC |
63 | |
| 64 | .. toctree:: | |
| 65 | :maxdepth: 2 | |
| 66 | ||
| dcec3c8c | 67 | driver-api/index |
| 24755a55 | 68 | core-api/index |
| b32febad | 69 | media/index |
| cb597fce | 70 | gpu/index |
| 799a545b | 71 | security/index |
| 8551914a | 72 | sound/index |
| 3b72c814 | 73 | crypto/index |
| 22cba31b | 74 | |
| ba42c574 SP |
75 | Korean translations |
| 76 | ------------------- | |
| 77 | ||
| 78 | .. toctree:: | |
| 79 | :maxdepth: 1 | |
| 80 | ||
| 81 | translations/ko_KR/index | |
| 82 | ||
| 2069889f AD |
83 | Chinese translations |
| 84 | -------------------- | |
| 85 | ||
| 86 | .. toctree:: | |
| 87 | :maxdepth: 1 | |
| 88 | ||
| 89 | translations/zh_CN/index | |
| 90 | ||
| f0127338 TS |
91 | Japanese translations |
| 92 | --------------------- | |
| 93 | ||
| 94 | .. toctree:: | |
| 95 | :maxdepth: 1 | |
| 96 | ||
| 97 | translations/ja_JP/index | |
| 98 | ||
| 22cba31b JN |
99 | Indices and tables |
| 100 | ================== | |
| 101 | ||
| 102 | * :ref:`genindex` |