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 their mitigations.
  21
  22 .. toctree::
  23    :maxdepth: 1
  24
  25    hw-vuln/index
  26
  27 Here is a set of documents aimed at users who are trying to track down
  28 problems and bugs in particular.
  29
  30 .. toctree::
  31    :maxdepth: 1
  32
  33    reporting-bugs
  34    security-bugs
  35    bug-hunting
  36    bug-bisect
  37    tainted-kernels
  38    ramoops
  39    dynamic-debug-howto
  40    init
  41
  42 This is the beginning of a section with information of interest to
  43 application developers.  Documents covering various aspects of the kernel
  44 ABI will be found here.
  45
  46 .. toctree::
  47    :maxdepth: 1
  48
  49    sysfs-rules
  50
  51 The rest of this manual consists of various unordered guides on how to
  52 configure specific aspects of kernel behavior to your liking.
  53
  54 .. toctree::
  55    :maxdepth: 1
  56
  57    initrd
  58    cgroup-v2
  59    serial-console
  60    braille-console
  61    parport
  62    md
  63    module-signing
  64    sysrq
  65    unicode
  66    vga-softcursor
  67    binfmt-misc
  68    mono
  69    java
  70    ras
  71    bcache
  72    pm/index
  73    thunderbolt
  74    LSM/index
  75    mm/index
  76
  77 .. only::  subproject and html
  78
  79    Indices
  80    =======
  81
  82    * :ref:`genindex`