projects / mirror_ubuntu-zesty-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 JC |
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 | ||
| 0e4f07a6 | 39 | process/index |
| c289312f | 40 | dev-tools/index |
| 1dc4bbf0 | 41 | doc-guide/index |
| b51208d4 JC |
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 | ||
| dcec3c8c | 55 | driver-api/index |
| 24755a55 | 56 | core-api/index |
| b32febad | 57 | media/index |
| cb597fce | 58 | gpu/index |
| 799a545b | 59 | security/index |
| 8551914a | 60 | sound/index |
| 3b72c814 | 61 | crypto/index |
| 22cba31b | 62 | |
| ba42c574 SP |
63 | Korean translations |
| 64 | ------------------- | |
| 65 | ||
| 66 | .. toctree:: | |
| 67 | :maxdepth: 1 | |
| 68 | ||
| 69 | translations/ko_KR/index | |
| 70 | ||
| 22cba31b JN |
71 | Indices and tables |
| 72 | ================== | |
| 73 | ||
| 74 | * :ref:`genindex` |