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