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    ioctl/index
  60
  61
  62 Introduction to kernel development
  63 ----------------------------------
  64
  65 These manuals contain overall information about how to develop the kernel.
  66 The kernel community is quite large, with thousands of developers
  67 contributing over the course of a year.  As with any large community,
  68 knowing how things are done will make the process of getting your changes
  69 merged much easier.
  70
  71 .. toctree::
  72    :maxdepth: 2
  73
  74    process/index
  75    dev-tools/index
  76    doc-guide/index
  77    kernel-hacking/index
  78    trace/index
  79    maintainer/index
  80
  81 Kernel API documentation
  82 ------------------------
  83
  84 These books get into the details of how specific kernel subsystems work
  85 from the point of view of a kernel developer.  Much of the information here
  86 is taken directly from the kernel source, with supplemental material added
  87 as needed (or at least as we managed to add it — probably *not* all that is
  88 needed).
  89
  90 .. toctree::
  91    :maxdepth: 2
  92
  93    driver-api/index
  94    core-api/index
  95    accounting/index
  96    block/index
  97    hid/index
  98    iio/index
  99    leds/index
 100    media/index
 101    networking/index
 102    input/index
 103    hwmon/index
 104    gpu/index
 105    security/index
 106    sound/index
 107    crypto/index
 108    filesystems/index
 109    vm/index
 110    bpf/index
 111    usb/index
 112    misc-devices/index
 113
 114 Architecture-specific documentation
 115 -----------------------------------
 116
 117 These books provide programming details about architecture-specific
 118 implementation.
 119
 120 .. toctree::
 121    :maxdepth: 2
 122
 123    sh/index
 124    arm/index
 125    arm64/index
 126    ia64/index
 127    m68k/index
 128    riscv/index
 129    s390/index
 130    sh/index
 131    sparc/index
 132    x86/index
 133    xtensa/index
 134
 135 Filesystem Documentation
 136 ------------------------
 137
 138 The documentation in this section are provided by specific filesystem
 139 subprojects.
 140
 141 .. toctree::
 142    :maxdepth: 2
 143
 144    filesystems/ext4/index
 145
 146 Translations
 147 ------------
 148
 149 .. toctree::
 150    :maxdepth: 2
 151
 152    translations/index
 153
 154 Indices and tables
 155 ==================
 156
 157 * :ref:`genindex`