xref: /openbmc/linux/Documentation/admin-guide/index.rst (revision 1ac731c529cd4d6adbce134754b51ff7d822b145)
17358bb2fSJonathan CorbetThe Linux kernel user's and administrator's guide
27358bb2fSJonathan Corbet=================================================
39d85025bSMauro Carvalho Chehab
47358bb2fSJonathan CorbetThe following is a collection of user-oriented documents that have been
57358bb2fSJonathan Corbetadded to the kernel over time.  There is, as yet, little overall order or
67358bb2fSJonathan Corbetorganization here — this material was not written to be a single, coherent
77358bb2fSJonathan Corbetdocument!  With luck things will improve quickly over time.
87358bb2fSJonathan Corbet
97358bb2fSJonathan CorbetThis initial section contains overall information, including the README
107358bb2fSJonathan Corbetfile describing the kernel as a whole, documentation on kernel parameters,
117358bb2fSJonathan Corbetetc.
129d85025bSMauro Carvalho Chehab
139d85025bSMauro Carvalho Chehab.. toctree::
147358bb2fSJonathan Corbet   :maxdepth: 1
159d85025bSMauro Carvalho Chehab
169d85025bSMauro Carvalho Chehab   README
177358bb2fSJonathan Corbet   kernel-parameters
187358bb2fSJonathan Corbet   devices
1957043247SMauro Carvalho Chehab   sysctl/index
207358bb2fSJonathan Corbet
21a7ee04b3SMauro Carvalho Chehab   abi
2263fdc462SMauro Carvalho Chehab   features
23a7ee04b3SMauro Carvalho Chehab
2465fd4cb6SThomas GleixnerThis section describes CPU vulnerabilities and their mitigations.
253ec8ce5dSThomas Gleixner
263ec8ce5dSThomas Gleixner.. toctree::
273ec8ce5dSThomas Gleixner   :maxdepth: 1
283ec8ce5dSThomas Gleixner
2965fd4cb6SThomas Gleixner   hw-vuln/index
303ec8ce5dSThomas Gleixner
317358bb2fSJonathan CorbetHere is a set of documents aimed at users who are trying to track down
327358bb2fSJonathan Corbetproblems and bugs in particular.
337358bb2fSJonathan Corbet
347358bb2fSJonathan Corbet.. toctree::
357358bb2fSJonathan Corbet   :maxdepth: 1
367358bb2fSJonathan Corbet
373e544d72SThorsten Leemhuis   reporting-issues
381ecf393fSThorsten Leemhuis   reporting-regressions
39*efe92046SThorsten Leemhuis   quickly-build-trimmed-linux
409d85025bSMauro Carvalho Chehab   bug-hunting
41c730904bSMauro Carvalho Chehab   bug-bisect
42337c188dSMauro Carvalho Chehab   tainted-kernels
439d85025bSMauro Carvalho Chehab   ramoops
449d85025bSMauro Carvalho Chehab   dynamic-debug-howto
457358bb2fSJonathan Corbet   init
46330d4810SMauro Carvalho Chehab   kdump/index
4759809fe8SMauro Carvalho Chehab   perf/index
4800d7c1e5SDaniel W. S. Almeida   pstore-blk
497358bb2fSJonathan Corbet
507358bb2fSJonathan CorbetThis is the beginning of a section with information of interest to
517358bb2fSJonathan Corbetapplication developers.  Documents covering various aspects of the kernel
527358bb2fSJonathan CorbetABI will be found here.
537358bb2fSJonathan Corbet
547358bb2fSJonathan Corbet.. toctree::
557358bb2fSJonathan Corbet   :maxdepth: 1
567358bb2fSJonathan Corbet
577358bb2fSJonathan Corbet   sysfs-rules
587358bb2fSJonathan Corbet
59b7cb8405SShuah KhanThis is the beginning of a section with information of interest to
60b7cb8405SShuah Khanapplication developers and system integrators doing analysis of the
61b7cb8405SShuah KhanLinux kernel for safety critical applications. Documents supporting
62b7cb8405SShuah Khananalysis of kernel interactions with applications, and key kernel
63b7cb8405SShuah Khansubsystems expectations will be found here.
64b7cb8405SShuah Khan
65b7cb8405SShuah Khan.. toctree::
66b7cb8405SShuah Khan   :maxdepth: 1
67b7cb8405SShuah Khan
68b7cb8405SShuah Khan   workload-tracing
69b7cb8405SShuah Khan
707358bb2fSJonathan CorbetThe rest of this manual consists of various unordered guides on how to
717358bb2fSJonathan Corbetconfigure specific aspects of kernel behavior to your liking.
727358bb2fSJonathan Corbet
737358bb2fSJonathan Corbet.. toctree::
747358bb2fSJonathan Corbet   :maxdepth: 1
757358bb2fSJonathan Corbet
76680e6ffaSChangbin Du   acpi/index
7783bbf6e1SMauro Carvalho Chehab   aoe/index
782c1d7ffdSJonathan Neuschäfer   auxdisplay/index
792c1d7ffdSJonathan Neuschäfer   bcache
802c1d7ffdSJonathan Neuschäfer   binderfs
812c1d7ffdSJonathan Neuschäfer   binfmt-misc
822c1d7ffdSJonathan Neuschäfer   blockdev/index
837b9b816fSMasami Hiramatsu   bootconfig
842c1d7ffdSJonathan Neuschäfer   braille-console
854f4cfa6cSMauro Carvalho Chehab   btmrvl
862c1d7ffdSJonathan Neuschäfer   cgroup-v1/index
872c1d7ffdSJonathan Neuschäfer   cgroup-v2
882c1d7ffdSJonathan Neuschäfer   cifs/index
894f4cfa6cSMauro Carvalho Chehab   clearing-warn-once
904f4cfa6cSMauro Carvalho Chehab   cpu-load
914f4cfa6cSMauro Carvalho Chehab   cputopology
92d4300c4eSJonathan Neuschäfer   dell_rbu
936cf2a73cSMauro Carvalho Chehab   device-mapper/index
94320bfd91SJonathan Neuschäfer   edid
954f4cfa6cSMauro Carvalho Chehab   efi-stub
962c1d7ffdSJonathan Neuschäfer   ext4
97c0baf9acSGabriel Krisman Bertazi   filesystem-monitoring
982f123b9aSDaniel W. S. Almeida   nfs/index
99c2746a1eSMauro Carvalho Chehab   gpio/index
1004f4cfa6cSMauro Carvalho Chehab   highuid
1014f4cfa6cSMauro Carvalho Chehab   hw_random
1022c1d7ffdSJonathan Neuschäfer   initrd
1034f4cfa6cSMauro Carvalho Chehab   iostats
1042c1d7ffdSJonathan Neuschäfer   java
1052c1d7ffdSJonathan Neuschäfer   jfs
1064f4cfa6cSMauro Carvalho Chehab   kernel-per-CPU-kthreads
1079e1cbedeSMauro Carvalho Chehab   laptops/index
1084f4cfa6cSMauro Carvalho Chehab   lcd-panel-cgram
1094f4cfa6cSMauro Carvalho Chehab   ldm
1104f4cfa6cSMauro Carvalho Chehab   lockup-watchdogs
1112c1d7ffdSJonathan Neuschäfer   LSM/index
1122c1d7ffdSJonathan Neuschäfer   md
11332e2eae2SMauro Carvalho Chehab   media/index
1142c1d7ffdSJonathan Neuschäfer   mm/index
1152c1d7ffdSJonathan Neuschäfer   module-signing
1162c1d7ffdSJonathan Neuschäfer   mono
1172c1d7ffdSJonathan Neuschäfer   namespaces/index
1184f4cfa6cSMauro Carvalho Chehab   numastat
1192c1d7ffdSJonathan Neuschäfer   parport
1202c1d7ffdSJonathan Neuschäfer   perf-security
1212c1d7ffdSJonathan Neuschäfer   pm/index
1224f4cfa6cSMauro Carvalho Chehab   pnp
1232c1d7ffdSJonathan Neuschäfer   rapidio
1242c1d7ffdSJonathan Neuschäfer   ras
1254f4cfa6cSMauro Carvalho Chehab   rtc
1262c1d7ffdSJonathan Neuschäfer   serial-console
1274f4cfa6cSMauro Carvalho Chehab   svga
128a4452e67SGabriel Krisman Bertazi   syscall-user-dispatch
1292c1d7ffdSJonathan Neuschäfer   sysrq
130e63273c1SBagas Sanjaya   thermal/index
1312c1d7ffdSJonathan Neuschäfer   thunderbolt
1322c1d7ffdSJonathan Neuschäfer   ufs
1332c1d7ffdSJonathan Neuschäfer   unicode
1342c1d7ffdSJonathan Neuschäfer   vga-softcursor
1354f4cfa6cSMauro Carvalho Chehab   video-output
1362c1d7ffdSJonathan Neuschäfer   xfs
1376f2ec3a9SMarkus Heiser
1386f2ec3a9SMarkus Heiser.. only::  subproject and html
1396f2ec3a9SMarkus Heiser
1406f2ec3a9SMarkus Heiser   Indices
1416f2ec3a9SMarkus Heiser   =======
1426f2ec3a9SMarkus Heiser
1436f2ec3a9SMarkus Heiser   * :ref:`genindex`
144