Documentation/index.rst

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