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    perf/index
  42
  43 This is the beginning of a section with information of interest to
  44 application developers.  Documents covering various aspects of the kernel
  45 ABI will be found here.
  46
  47 .. toctree::
  48    :maxdepth: 1
  49
  50    sysfs-rules
  51
  52 The rest of this manual consists of various unordered guides on how to
  53 configure specific aspects of kernel behavior to your liking.
  54
  55 .. toctree::
  56    :maxdepth: 1
  57
  58    initrd
  59    cgroup-v2
  60    serial-console
  61    braille-console
  62    parport
  63    md
  64    module-signing
  65    rapidio
  66    sysrq
  67    unicode
  68    vga-softcursor
  69    binfmt-misc
  70    mono
  71    java
  72    ras
  73    bcache
  74    ext4
  75    binderfs
  76    pm/index
  77    thunderbolt
  78    LSM/index
  79    mm/index
  80    namespaces/index
  81    perf-security
  82    acpi/index
  83    device-mapper/index
  84
  85 .. only::  subproject and html
  86
  87    Indices
  88    =======
  89
  90    * :ref:`genindex`