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