Documentation/index.rst

   1
   2 .. The Linux Kernel documentation master file, created by
   3    sphinx-quickstart on Fri Feb 12 13:51:46 2016.
   4    You can adapt this file completely to your liking, but it should at least
   5    contain the root `toctree` directive.
   6
   7 .. _linux_doc:
   8
   9 The Linux Kernel documentation
  10 ==============================
  11
  12 This is the top level of the kernel's documentation tree.  Kernel
  13 documentation, like the kernel itself, is very much a work in progress;
  14 that is especially true as we work to integrate our many scattered
  15 documents into a coherent whole.  Please note that improvements to the
  16 documentation are welcome; join the linux-doc list at vger.kernel.org if
  17 you want to help out.
  18
  19 Licensing documentation
  20 -----------------------
  21
  22 The following describes the license of the Linux kernel source code
  23 (GPLv2), how to properly mark the license of individual files in the source
  24 tree, as well as links to the full license text.
  25
  26 * :ref:`kernel_licensing`
  27
  28 User-oriented documentation
  29 ---------------------------
  30
  31 The following manuals are written for *users* of the kernel — those who are
  32 trying to get it to work optimally on a given system.
  33
  34 .. toctree::
  35    :maxdepth: 2
  36
  37    admin-guide/index
  38
  39 Firmware-related documentation
  40 ------------------------------
  41 The following holds information on the kernel's expectations regarding the
  42 platform firmwares.
  43
  44 .. toctree::
  45    :maxdepth: 2
  46
  47    firmware-guide/index
  48
  49 Application-developer documentation
  50 -----------------------------------
  51
  52 The user-space API manual gathers together documents describing aspects of
  53 the kernel interface as seen by application developers.
  54
  55 .. toctree::
  56    :maxdepth: 2
  57
  58    userspace-api/index
  59
  60
  61 Introduction to kernel development
  62 ----------------------------------
  63
  64 These manuals contain overall information about how to develop the kernel.
  65 The kernel community is quite large, with thousands of developers
  66 contributing over the course of a year.  As with any large community,
  67 knowing how things are done will make the process of getting your changes
  68 merged much easier.
  69
  70 .. toctree::
  71    :maxdepth: 2
  72
  73    process/index
  74    dev-tools/index
  75    doc-guide/index
  76    kernel-hacking/index
  77    trace/index
  78    maintainer/index
  79
  80 Kernel API documentation
  81 ------------------------
  82
  83 These books get into the details of how specific kernel subsystems work
  84 from the point of view of a kernel developer.  Much of the information here
  85 is taken directly from the kernel source, with supplemental material added
  86 as needed (or at least as we managed to add it — probably *not* all that is
  87 needed).
  88
  89 .. toctree::
  90    :maxdepth: 2
  91
  92    driver-api/index
  93    core-api/index
  94    media/index
  95    networking/index
  96    input/index
  97    hwmon/index
  98    gpu/index
  99    security/index
 100    sound/index
 101    crypto/index
 102    filesystems/index
 103    vm/index
 104    bpf/index
 105    usb/index
 106    misc-devices/index
 107
 108 Architecture-specific documentation
 109 -----------------------------------
 110
 111 These books provide programming details about architecture-specific
 112 implementation.
 113
 114 .. toctree::
 115    :maxdepth: 2
 116
 117    sh/index
 118    x86/index
 119
 120 Filesystem Documentation
 121 ------------------------
 122
 123 The documentation in this section are provided by specific filesystem
 124 subprojects.
 125
 126 .. toctree::
 127    :maxdepth: 2
 128
 129    filesystems/ext4/index
 130
 131 Translations
 132 ------------
 133
 134 .. toctree::
 135    :maxdepth: 2
 136
 137    translations/index
 138
 139 Indices and tables
 140 ==================
 141
 142 * :ref:`genindex`