162306a36Sopenharmony_ci.. SPDX-License-Identifier: GPL-2.0 262306a36Sopenharmony_ci 362306a36Sopenharmony_ci.. _linux_doc: 462306a36Sopenharmony_ci 562306a36Sopenharmony_ci============================== 662306a36Sopenharmony_ciThe Linux Kernel documentation 762306a36Sopenharmony_ci============================== 862306a36Sopenharmony_ci 962306a36Sopenharmony_ciThis is the top level of the kernel's documentation tree. Kernel 1062306a36Sopenharmony_cidocumentation, like the kernel itself, is very much a work in progress; 1162306a36Sopenharmony_cithat is especially true as we work to integrate our many scattered 1262306a36Sopenharmony_cidocuments into a coherent whole. Please note that improvements to the 1362306a36Sopenharmony_cidocumentation are welcome; join the linux-doc list at vger.kernel.org if 1462306a36Sopenharmony_ciyou want to help out. 1562306a36Sopenharmony_ci 1662306a36Sopenharmony_ciWorking with the development community 1762306a36Sopenharmony_ci====================================== 1862306a36Sopenharmony_ci 1962306a36Sopenharmony_ciThe essential guides for interacting with the kernel's development 2062306a36Sopenharmony_cicommunity and getting your work upstream. 2162306a36Sopenharmony_ci 2262306a36Sopenharmony_ci.. toctree:: 2362306a36Sopenharmony_ci :maxdepth: 1 2462306a36Sopenharmony_ci 2562306a36Sopenharmony_ci process/development-process 2662306a36Sopenharmony_ci process/submitting-patches 2762306a36Sopenharmony_ci Code of conduct <process/code-of-conduct> 2862306a36Sopenharmony_ci maintainer/index 2962306a36Sopenharmony_ci All development-process docs <process/index> 3062306a36Sopenharmony_ci 3162306a36Sopenharmony_ci 3262306a36Sopenharmony_ciInternal API manuals 3362306a36Sopenharmony_ci==================== 3462306a36Sopenharmony_ci 3562306a36Sopenharmony_ciManuals for use by developers working to interface with the rest of the 3662306a36Sopenharmony_cikernel. 3762306a36Sopenharmony_ci 3862306a36Sopenharmony_ci.. toctree:: 3962306a36Sopenharmony_ci :maxdepth: 1 4062306a36Sopenharmony_ci 4162306a36Sopenharmony_ci core-api/index 4262306a36Sopenharmony_ci driver-api/index 4362306a36Sopenharmony_ci subsystem-apis 4462306a36Sopenharmony_ci Locking in the kernel <locking/index> 4562306a36Sopenharmony_ci 4662306a36Sopenharmony_ciDevelopment tools and processes 4762306a36Sopenharmony_ci=============================== 4862306a36Sopenharmony_ci 4962306a36Sopenharmony_ciVarious other manuals with useful information for all kernel developers. 5062306a36Sopenharmony_ci 5162306a36Sopenharmony_ci.. toctree:: 5262306a36Sopenharmony_ci :maxdepth: 1 5362306a36Sopenharmony_ci 5462306a36Sopenharmony_ci process/license-rules 5562306a36Sopenharmony_ci doc-guide/index 5662306a36Sopenharmony_ci dev-tools/index 5762306a36Sopenharmony_ci dev-tools/testing-overview 5862306a36Sopenharmony_ci kernel-hacking/index 5962306a36Sopenharmony_ci trace/index 6062306a36Sopenharmony_ci fault-injection/index 6162306a36Sopenharmony_ci livepatch/index 6262306a36Sopenharmony_ci rust/index 6362306a36Sopenharmony_ci 6462306a36Sopenharmony_ci 6562306a36Sopenharmony_ciUser-oriented documentation 6662306a36Sopenharmony_ci=========================== 6762306a36Sopenharmony_ci 6862306a36Sopenharmony_ciThe following manuals are written for *users* of the kernel — those who are 6962306a36Sopenharmony_citrying to get it to work optimally on a given system and application 7062306a36Sopenharmony_cidevelopers seeking information on the kernel's user-space APIs. 7162306a36Sopenharmony_ci 7262306a36Sopenharmony_ci.. toctree:: 7362306a36Sopenharmony_ci :maxdepth: 1 7462306a36Sopenharmony_ci 7562306a36Sopenharmony_ci admin-guide/index 7662306a36Sopenharmony_ci The kernel build system <kbuild/index> 7762306a36Sopenharmony_ci admin-guide/reporting-issues.rst 7862306a36Sopenharmony_ci User-space tools <tools/index> 7962306a36Sopenharmony_ci userspace-api/index 8062306a36Sopenharmony_ci 8162306a36Sopenharmony_ciSee also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_, 8262306a36Sopenharmony_ciwhich are kept separately from the kernel's own documentation. 8362306a36Sopenharmony_ci 8462306a36Sopenharmony_ciFirmware-related documentation 8562306a36Sopenharmony_ci============================== 8662306a36Sopenharmony_ciThe following holds information on the kernel's expectations regarding the 8762306a36Sopenharmony_ciplatform firmwares. 8862306a36Sopenharmony_ci 8962306a36Sopenharmony_ci.. toctree:: 9062306a36Sopenharmony_ci :maxdepth: 1 9162306a36Sopenharmony_ci 9262306a36Sopenharmony_ci firmware-guide/index 9362306a36Sopenharmony_ci devicetree/index 9462306a36Sopenharmony_ci 9562306a36Sopenharmony_ci 9662306a36Sopenharmony_ciArchitecture-specific documentation 9762306a36Sopenharmony_ci=================================== 9862306a36Sopenharmony_ci 9962306a36Sopenharmony_ci.. toctree:: 10062306a36Sopenharmony_ci :maxdepth: 2 10162306a36Sopenharmony_ci 10262306a36Sopenharmony_ci arch/index 10362306a36Sopenharmony_ci 10462306a36Sopenharmony_ci 10562306a36Sopenharmony_ciOther documentation 10662306a36Sopenharmony_ci=================== 10762306a36Sopenharmony_ci 10862306a36Sopenharmony_ciThere are several unsorted documents that don't seem to fit on other parts 10962306a36Sopenharmony_ciof the documentation body, or may require some adjustments and/or conversion 11062306a36Sopenharmony_cito ReStructured Text format, or are simply too old. 11162306a36Sopenharmony_ci 11262306a36Sopenharmony_ci.. toctree:: 11362306a36Sopenharmony_ci :maxdepth: 1 11462306a36Sopenharmony_ci 11562306a36Sopenharmony_ci staging/index 11662306a36Sopenharmony_ci 11762306a36Sopenharmony_ci 11862306a36Sopenharmony_ciTranslations 11962306a36Sopenharmony_ci============ 12062306a36Sopenharmony_ci 12162306a36Sopenharmony_ci.. toctree:: 12262306a36Sopenharmony_ci :maxdepth: 2 12362306a36Sopenharmony_ci 12462306a36Sopenharmony_ci translations/index 12562306a36Sopenharmony_ci 12662306a36Sopenharmony_ciIndices and tables 12762306a36Sopenharmony_ci================== 12862306a36Sopenharmony_ci 12962306a36Sopenharmony_ci* :ref:`genindex` 130