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