Documentation/index.rst

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