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    kbuild/index
  39
  40 Firmware-related documentation
  41 ------------------------------
  42 The following holds information on the kernel's expectations regarding the
  43 platform firmwares.
  44
  45 .. toctree::
  46    :maxdepth: 2
  47
  48    firmware-guide/index
  49
  50 Application-developer documentation
  51 -----------------------------------
  52
  53 The user-space API manual gathers together documents describing aspects of
  54 the kernel interface as seen by application developers.
  55
  56 .. toctree::
  57    :maxdepth: 2
  58
  59    userspace-api/index
  60    ioctl/index
  61
  62
  63 Introduction to kernel development
  64 ----------------------------------
  65
  66 These manuals contain overall information about how to develop the kernel.
  67 The kernel community is quite large, with thousands of developers
  68 contributing over the course of a year.  As with any large community,
  69 knowing how things are done will make the process of getting your changes
  70 merged much easier.
  71
  72 .. toctree::
  73    :maxdepth: 2
  74
  75    process/index
  76    dev-tools/index
  77    doc-guide/index
  78    kernel-hacking/index
  79    trace/index
  80    maintainer/index
  81    fault-injection/index
  82    livepatch/index
  83
  84
  85 Kernel API documentation
  86 ------------------------
  87
  88 These books get into the details of how specific kernel subsystems work
  89 from the point of view of a kernel developer.  Much of the information here
  90 is taken directly from the kernel source, with supplemental material added
  91 as needed (or at least as we managed to add it — probably *not* all that is
  92 needed).
  93
  94 .. toctree::
  95    :maxdepth: 2
  96
  97    driver-api/index
  98    core-api/index
  99    locking/index
 100    accounting/index
 101    block/index
 102    cdrom/index
 103    ide/index
 104    fb/index
 105    fpga/index
 106    hid/index
 107    iio/index
 108    infiniband/index
 109    leds/index
 110    media/index
 111    netlabel/index
 112    networking/index
 113    pcmcia/index
 114    power/index
 115    target/index
 116    timers/index
 117    watchdog/index
 118    virtual/index
 119    input/index
 120    hwmon/index
 121    gpu/index
 122    security/index
 123    sound/index
 124    crypto/index
 125    filesystems/index
 126    vm/index
 127    bpf/index
 128    usb/index
 129    PCI/index
 130    misc-devices/index
 131    mic/index
 132    scheduler/index
 133
 134 Architecture-specific documentation
 135 -----------------------------------
 136
 137 These books provide programming details about architecture-specific
 138 implementation.
 139
 140 .. toctree::
 141    :maxdepth: 2
 142
 143    sh/index
 144    arm/index
 145    arm64/index
 146    ia64/index
 147    m68k/index
 148    powerpc/index
 149    riscv/index
 150    s390/index
 151    sh/index
 152    sparc/index
 153    x86/index
 154    xtensa/index
 155
 156 Filesystem Documentation
 157 ------------------------
 158
 159 The documentation in this section are provided by specific filesystem
 160 subprojects.
 161
 162 .. toctree::
 163    :maxdepth: 2
 164
 165    filesystems/ext4/index
 166
 167 Translations
 168 ------------
 169
 170 .. toctree::
 171    :maxdepth: 2
 172
 173    translations/index
 174
 175 Indices and tables
 176 ==================
 177
 178 * :ref:`genindex`