xref: /openbmc/linux/Documentation/admin-guide/index.rst (revision e7751617dd0599ceadf4221cb08e04307b00aa1f)
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   sysctl/index
20
21This section describes CPU vulnerabilities and their mitigations.
22
23.. toctree::
24   :maxdepth: 1
25
26   hw-vuln/index
27
28Here is a set of documents aimed at users who are trying to track down
29problems and bugs in particular.
30
31.. toctree::
32   :maxdepth: 1
33
34   reporting-bugs
35   security-bugs
36   bug-hunting
37   bug-bisect
38   tainted-kernels
39   ramoops
40   dynamic-debug-howto
41   init
42   kdump/index
43   perf/index
44
45This is the beginning of a section with information of interest to
46application developers.  Documents covering various aspects of the kernel
47ABI will be found here.
48
49.. toctree::
50   :maxdepth: 1
51
52   sysfs-rules
53
54The rest of this manual consists of various unordered guides on how to
55configure specific aspects of kernel behavior to your liking.
56
57.. toctree::
58   :maxdepth: 1
59
60   initrd
61   cgroup-v2
62   serial-console
63   braille-console
64   parport
65   md
66   module-signing
67   rapidio
68   sysrq
69   unicode
70   vga-softcursor
71   binfmt-misc
72   mono
73   java
74   ras
75   bcache
76   blockdev/index
77   ext4
78   binderfs
79   pm/index
80   thunderbolt
81   LSM/index
82   mm/index
83   namespaces/index
84   perf-security
85   acpi/index
86   device-mapper/index
87   laptops/index
88
89.. only::  subproject and html
90
91   Indices
92   =======
93
94   * :ref:`genindex`
95