LXR linux/Documentation/index.rst

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