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 6Welcome to The Linux Kernel's 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 55Kernel API documentation 56------------------------ 57 58These books get into the details of how specific kernel subsystems work 59from the point of view of a kernel developer. Much of the information here 60is taken directly from the kernel source, with supplemental material added 61as needed (or at least as we managed to add it — probably *not* all that is 62needed). 63 64.. toctree:: 65 :maxdepth: 2 66 67 driver-api/index 68 core-api/index 69 media/index 70 gpu/index 71 security/index 72 sound/index 73 crypto/index 74 75Korean translations 76------------------- 77 78.. toctree:: 79 :maxdepth: 1 80 81 translations/ko_KR/index 82 83Chinese translations 84-------------------- 85 86.. toctree:: 87 :maxdepth: 1 88 89 translations/zh_CN/index 90 91Japanese translations 92--------------------- 93 94.. toctree:: 95 :maxdepth: 1 96 97 translations/ja_JP/index 98 99Indices and tables 100================== 101 102* :ref:`genindex` 103