| Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame^] | 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 | .. _linux_doc: |
| 7 | |
| 8 | The Linux Kernel documentation |
| 9 | ============================== |
| 10 | |
| 11 | This is the top level of the kernel's documentation tree. Kernel |
| 12 | documentation, like the kernel itself, is very much a work in progress; |
| 13 | that is especially true as we work to integrate our many scattered |
| 14 | documents into a coherent whole. Please note that improvements to the |
| 15 | documentation are welcome; join the linux-doc list at vger.kernel.org if |
| 16 | you want to help out. |
| 17 | |
| 18 | Licensing documentation |
| 19 | ----------------------- |
| 20 | |
| 21 | The following describes the license of the Linux kernel source code |
| 22 | (GPLv2), how to properly mark the license of individual files in the source |
| 23 | tree, as well as links to the full license text. |
| 24 | |
| 25 | .. toctree:: |
| 26 | :maxdepth: 2 |
| 27 | |
| 28 | process/license-rules.rst |
| 29 | |
| 30 | User-oriented documentation |
| 31 | --------------------------- |
| 32 | |
| 33 | The following manuals are written for *users* of the kernel — those who are |
| 34 | trying to get it to work optimally on a given system. |
| 35 | |
| 36 | .. toctree:: |
| 37 | :maxdepth: 2 |
| 38 | |
| 39 | admin-guide/index |
| 40 | |
| 41 | Application-developer documentation |
| 42 | ----------------------------------- |
| 43 | |
| 44 | The user-space API manual gathers together documents describing aspects of |
| 45 | the kernel interface as seen by application developers. |
| 46 | |
| 47 | .. toctree:: |
| 48 | :maxdepth: 2 |
| 49 | |
| 50 | userspace-api/index |
| 51 | |
| 52 | |
| 53 | Introduction to kernel development |
| 54 | ---------------------------------- |
| 55 | |
| 56 | These manuals contain overall information about how to develop the kernel. |
| 57 | The kernel community is quite large, with thousands of developers |
| 58 | contributing over the course of a year. As with any large community, |
| 59 | knowing how things are done will make the process of getting your changes |
| 60 | merged much easier. |
| 61 | |
| 62 | .. toctree:: |
| 63 | :maxdepth: 2 |
| 64 | |
| 65 | process/index |
| 66 | dev-tools/index |
| 67 | doc-guide/index |
| 68 | kernel-hacking/index |
| 69 | trace/index |
| 70 | maintainer/index |
| 71 | |
| 72 | Kernel API documentation |
| 73 | ------------------------ |
| 74 | |
| 75 | These books get into the details of how specific kernel subsystems work |
| 76 | from the point of view of a kernel developer. Much of the information here |
| 77 | is taken directly from the kernel source, with supplemental material added |
| 78 | as needed (or at least as we managed to add it — probably *not* all that is |
| 79 | needed). |
| 80 | |
| 81 | .. toctree:: |
| 82 | :maxdepth: 2 |
| 83 | |
| 84 | driver-api/index |
| 85 | core-api/index |
| 86 | media/index |
| 87 | networking/index |
| 88 | input/index |
| 89 | gpu/index |
| 90 | security/index |
| 91 | sound/index |
| 92 | crypto/index |
| 93 | filesystems/index |
| 94 | vm/index |
| 95 | bpf/index |
| 96 | |
| 97 | Architecture-specific documentation |
| 98 | ----------------------------------- |
| 99 | |
| 100 | These books provide programming details about architecture-specific |
| 101 | implementation. |
| 102 | |
| 103 | .. toctree:: |
| 104 | :maxdepth: 2 |
| 105 | |
| 106 | sh/index |
| 107 | |
| 108 | Filesystem Documentation |
| 109 | ------------------------ |
| 110 | |
| 111 | The documentation in this section are provided by specific filesystem |
| 112 | subprojects. |
| 113 | |
| 114 | .. toctree:: |
| 115 | :maxdepth: 2 |
| 116 | |
| 117 | filesystems/ext4/index |
| 118 | |
| 119 | Translations |
| 120 | ------------ |
| 121 | |
| 122 | .. toctree:: |
| 123 | :maxdepth: 2 |
| 124 | |
| 125 | translations/index |
| 126 | |
| 127 | Indices and tables |
| 128 | ================== |
| 129 | |
| 130 | * :ref:`genindex` |