Documentation/admin-guide/index.rst

   1 The Linux kernel user's and administrator's guide
   2 =================================================
   3
   4 The following is a collection of user-oriented documents that have been
   5 added to the kernel over time.  There is, as yet, little overall order or
   6 organization here — this material was not written to be a single, coherent
   7 document!  With luck things will improve quickly over time.
   8
   9 This initial section contains overall information, including the README
  10 file describing the kernel as a whole, documentation on kernel parameters,
  11 etc.
  12
  13 .. toctree::
  14    :maxdepth: 1
  15
  16    README
  17    kernel-parameters
  18    devices
  19
  20 This section describes CPU vulnerabilities and provides an overview of the
  21 possible mitigations along with guidance for selecting mitigations if they
  22 are configurable at compile, boot or run time.
  23
  24 .. toctree::
  25    :maxdepth: 1
  26
  27    l1tf
  28
  29 Here is a set of documents aimed at users who are trying to track down
  30 problems and bugs in particular.
  31
  32 .. toctree::
  33    :maxdepth: 1
  34
  35    reporting-bugs
  36    security-bugs
  37    bug-hunting
  38    bug-bisect
  39    tainted-kernels
  40    ramoops
  41    dynamic-debug-howto
  42    init
  43
  44 This is the beginning of a section with information of interest to
  45 application developers.  Documents covering various aspects of the kernel
  46 ABI will be found here.
  47
  48 .. toctree::
  49    :maxdepth: 1
  50
  51    sysfs-rules
  52
  53 The rest of this manual consists of various unordered guides on how to
  54 configure specific aspects of kernel behavior to your liking.
  55
  56 .. toctree::
  57    :maxdepth: 1
  58
  59    initrd
  60    serial-console
  61    braille-console
  62    parport
  63    md
  64    module-signing
  65    sysrq
  66    unicode
  67    vga-softcursor
  68    binfmt-misc
  69    mono
  70    java
  71    ras
  72    pm/index
  73    thunderbolt
  74    LSM/index
  75
  76 .. only::  subproject and html
  77
  78    Indices
  79    =======
  80
  81    * :ref:`genindex`