xref: /linux/Documentation/admin-guide/index.rst (revision 597473720f4dc69749542bfcfed4a927a43d935e)
1The Linux kernel user's and administrator's guide
2=================================================
3
4The following is a collection of user-oriented documents that have been
5added to the kernel over time.  There is, as yet, little overall order or
6organization here — this material was not written to be a single, coherent
7document!  With luck things will improve quickly over time.
8
9This initial section contains overall information, including the README
10file describing the kernel as a whole, documentation on kernel parameters,
11etc.
12
13.. toctree::
14   :maxdepth: 1
15
16   README
17   kernel-parameters
18   devices
19
20This section describes CPU vulnerabilities and provides an overview of the
21possible mitigations along with guidance for selecting mitigations if they
22are configurable at compile, boot or run time.
23
24.. toctree::
25   :maxdepth: 1
26
27   l1tf
28
29Here is a set of documents aimed at users who are trying to track down
30problems and bugs in particular.
31
32.. toctree::
33   :maxdepth: 1
34
35   reporting-bugs
36   security-bugs
37   bug-hunting
38   bug-bisect
39   tainted-kernels
40   ramoops
41   dynamic-debug-howto
42   init
43
44This is the beginning of a section with information of interest to
45application developers.  Documents covering various aspects of the kernel
46ABI will be found here.
47
48.. toctree::
49   :maxdepth: 1
50
51   sysfs-rules
52
53The rest of this manual consists of various unordered guides on how to
54configure specific aspects of kernel behavior to your liking.
55
56.. toctree::
57   :maxdepth: 1
58
59   initrd
60   cgroup-v2
61   serial-console
62   braille-console
63   parport
64   md
65   module-signing
66   sysrq
67   unicode
68   vga-softcursor
69   binfmt-misc
70   mono
71   java
72   ras
73   bcache
74   ext4
75   pm/index
76   thunderbolt
77   LSM/index
78   mm/index
79   perf-security
80
81.. only::  subproject and html
82
83   Indices
84   =======
85
86   * :ref:`genindex`
87