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