1.. SPDX-License-Identifier: GPL-2.0 2 3.. _linux_doc: 4 5The Linux Kernel documentation 6============================== 7 8This is the top level of the kernel's documentation tree. Kernel 9documentation, like the kernel itself, is very much a work in progress; 10that is especially true as we work to integrate our many scattered 11documents into a coherent whole. Please note that improvements to the 12documentation are welcome; join the linux-doc list at vger.kernel.org if 13you want to help out. 14 15Working with the development community 16-------------------------------------- 17 18The essential guides for interacting with the kernel's development 19community and getting your work upstream. 20 21.. toctree:: 22 :maxdepth: 1 23 24 process/development-process 25 process/submitting-patches 26 Code of conduct <process/code-of-conduct> 27 maintainer/index 28 All development-process docs <process/index> 29 30 31Internal API manuals 32-------------------- 33 34Manuals for use by developers working to interface with the rest of the 35kernel. 36 37.. toctree:: 38 :maxdepth: 1 39 40 core-api/index 41 driver-api/index 42 subsystem-apis 43 Locking in the kernel <locking/index> 44 45Development tools and processes 46------------------------------- 47 48Various other manuals with useful information for all kernel developers. 49 50.. toctree:: 51 :maxdepth: 1 52 53 process/license-rules 54 doc-guide/index 55 dev-tools/index 56 dev-tools/testing-overview 57 kernel-hacking/index 58 trace/index 59 fault-injection/index 60 livepatch/index 61 62 63User-oriented documentation 64--------------------------- 65 66The following manuals are written for *users* of the kernel — those who are 67trying to get it to work optimally on a given system and application 68developers seeking information on the kernel's user-space APIs. 69 70.. toctree:: 71 :maxdepth: 1 72 73 admin-guide/index 74 The kernel build system <kbuild/index> 75 admin-guide/reporting-issues.rst 76 User-space tools <tools/index> 77 userspace-api/index 78 79See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_, 80which are kept separately from the kernel's own documentation. 81 82Firmware-related documentation 83------------------------------ 84The following holds information on the kernel's expectations regarding the 85platform firmwares. 86 87.. toctree:: 88 :maxdepth: 1 89 90 firmware-guide/index 91 devicetree/index 92 93 94Architecture-specific documentation 95----------------------------------- 96 97.. toctree:: 98 :maxdepth: 2 99 100 arch 101 102 103Other documentation 104------------------- 105 106There are several unsorted documents that don't seem to fit on other parts 107of the documentation body, or may require some adjustments and/or conversion 108to ReStructured Text format, or are simply too old. 109 110.. toctree:: 111 :maxdepth: 1 112 113 staging/index 114 115 116Translations 117------------ 118 119.. toctree:: 120 :maxdepth: 2 121 122 translations/index 123 124Indices and tables 125================== 126 127* :ref:`genindex` 128