Documentation/admin-guide/index.rst

   1 =================================================
   2 The Linux kernel user's and administrator's guide
   3 =================================================
   4
   5 The following is a collection of user-oriented documents that have been
   6 added to the kernel over time.  There is, as yet, little overall order or
   7 organization here — this material was not written to be a single, coherent
   8 document!  With luck things will improve quickly over time.
   9
  10 This initial section contains overall information, including the README
  11 file describing the kernel as a whole, documentation on kernel parameters,
  12 etc.
  13
  14 .. toctree::
  15    :maxdepth: 1
  16
  17    README
  18    kernel-parameters
  19    devices
  20    sysctl/index
  21
  22    abi
  23    features
  24
  25 This section describes CPU vulnerabilities and their mitigations.
  26
  27 .. toctree::
  28    :maxdepth: 1
  29
  30    hw-vuln/index
  31
  32 Here is a set of documents aimed at users who are trying to track down
  33 problems and bugs in particular.
  34
  35 .. toctree::
  36    :maxdepth: 1
  37
  38    reporting-issues
  39    reporting-regressions
  40    quickly-build-trimmed-linux
  41    verify-bugs-and-bisect-regressions
  42    bug-hunting
  43    bug-bisect
  44    tainted-kernels
  45    ramoops
  46    dynamic-debug-howto
  47    init
  48    kdump/index
  49    perf/index
  50    pstore-blk
  51
  52 This is the beginning of a section with information of interest to
  53 application developers.  Documents covering various aspects of the kernel
  54 ABI will be found here.
  55
  56 .. toctree::
  57    :maxdepth: 1
  58
  59    sysfs-rules
  60
  61 This is the beginning of a section with information of interest to
  62 application developers and system integrators doing analysis of the
  63 Linux kernel for safety critical applications. Documents supporting
  64 analysis of kernel interactions with applications, and key kernel
  65 subsystems expectations will be found here.
  66
  67 .. toctree::
  68    :maxdepth: 1
  69
  70    workload-tracing
  71
  72 The rest of this manual consists of various unordered guides on how to
  73 configure specific aspects of kernel behavior to your liking.
  74
  75 .. toctree::
  76    :maxdepth: 1
  77
  78    acpi/index
  79    aoe/index
  80    auxdisplay/index
  81    bcache
  82    binderfs
  83    binfmt-misc
  84    blockdev/index
  85    bootconfig
  86    braille-console
  87    btmrvl
  88    cgroup-v1/index
  89    cgroup-v2
  90    cifs/index
  91    clearing-warn-once
  92    cpu-load
  93    cputopology
  94    dell_rbu
  95    device-mapper/index
  96    edid
  97    efi-stub
  98    ext4
  99    filesystem-monitoring
 100    nfs/index
 101    gpio/index
 102    highuid
 103    hw_random
 104    initrd
 105    iostats
 106    java
 107    jfs
 108    kernel-per-CPU-kthreads
 109    laptops/index
 110    lcd-panel-cgram
 111    ldm
 112    lockup-watchdogs
 113    LSM/index
 114    md
 115    media/index
 116    mm/index
 117    module-signing
 118    mono
 119    namespaces/index
 120    numastat
 121    parport
 122    perf-security
 123    pm/index
 124    pmf
 125    pnp
 126    rapidio
 127    RAS/index
 128    rtc
 129    serial-console
 130    svga
 131    syscall-user-dispatch
 132    sysrq
 133    thermal/index
 134    thunderbolt
 135    ufs
 136    unicode
 137    vga-softcursor
 138    video-output
 139    xfs
 140
 141 .. only::  subproject and html
 142
 143    Indices
 144    =======
 145
 146    * :ref:`genindex`