xref: /linux/Documentation/admin-guide/index.rst (revision 55d0969c451159cff86949b38c39171cab962069)
1=================================================
2The Linux kernel user's and administrator's guide
3=================================================
4
5The following is a collection of user-oriented documents that have been
6added to the kernel over time.  There is, as yet, little overall order or
7organization here — this material was not written to be a single, coherent
8document!  With luck things will improve quickly over time.
9
10This initial section contains overall information, including the README
11file describing the kernel as a whole, documentation on kernel parameters,
12etc.
13
14.. toctree::
15   :maxdepth: 1
16
17   README
18   kernel-parameters
19   devices
20   sysctl/index
21
22   abi
23   features
24
25This section describes CPU vulnerabilities and their mitigations.
26
27.. toctree::
28   :maxdepth: 1
29
30   hw-vuln/index
31
32Here is a set of documents aimed at users who are trying to track down
33problems 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
52This is the beginning of a section with information of interest to
53application developers.  Documents covering various aspects of the kernel
54ABI will be found here.
55
56.. toctree::
57   :maxdepth: 1
58
59   sysfs-rules
60
61This is the beginning of a section with information of interest to
62application developers and system integrators doing analysis of the
63Linux kernel for safety critical applications. Documents supporting
64analysis of kernel interactions with applications, and key kernel
65subsystems expectations will be found here.
66
67.. toctree::
68   :maxdepth: 1
69
70   workload-tracing
71
72The rest of this manual consists of various unordered guides on how to
73configure 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   pnp
125   rapidio
126   RAS/index
127   rtc
128   serial-console
129   svga
130   syscall-user-dispatch
131   sysrq
132   thermal/index
133   thunderbolt
134   ufs
135   unicode
136   vga-softcursor
137   video-output
138   xfs
139
140.. only::  subproject and html
141
142   Indices
143   =======
144
145   * :ref:`genindex`
146