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    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 The rest of this manual consists of various unordered guides on how to
  60 configure specific aspects of kernel behavior to your liking.
  61
  62 .. toctree::
  63    :maxdepth: 1
  64
  65    acpi/index
  66    aoe/index
  67    auxdisplay/index
  68    bcache
  69    binderfs
  70    binfmt-misc
  71    blockdev/index
  72    bootconfig
  73    braille-console
  74    btmrvl
  75    cgroup-v1/index
  76    cgroup-v2
  77    cifs/index
  78    clearing-warn-once
  79    cpu-load
  80    cputopology
  81    dell_rbu
  82    device-mapper/index
  83    edid
  84    efi-stub
  85    ext4
  86    filesystem-monitoring
  87    nfs/index
  88    gpio/index
  89    highuid
  90    hw_random
  91    initrd
  92    iostats
  93    java
  94    jfs
  95    kernel-per-CPU-kthreads
  96    laptops/index
  97    lcd-panel-cgram
  98    ldm
  99    lockup-watchdogs
 100    LSM/index
 101    md
 102    media/index
 103    mm/index
 104    module-signing
 105    mono
 106    namespaces/index
 107    numastat
 108    parport
 109    perf-security
 110    pm/index
 111    pnp
 112    rapidio
 113    ras
 114    rtc
 115    serial-console
 116    svga
 117    syscall-user-dispatch
 118    sysrq
 119    thunderbolt
 120    ufs
 121    unicode
 122    vga-softcursor
 123    video-output
 124    xfs
 125
 126 .. only::  subproject and html
 127
 128    Indices
 129    =======
 130
 131    * :ref:`genindex`