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