Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
10General guides to kernel administration
11---------------------------------------
12
13This initial section contains overall information, including the README
14file describing the kernel as a whole, documentation on kernel parameters,
15etc.
16
17.. toctree::
18 :maxdepth: 1
19
20 README
21 devices
22
23 features
24
25A big part of the kernel's administrative interface is the /proc and sysfs
26virtual filesystems; these documents describe how to interact with tem
27
28.. toctree::
29 :maxdepth: 1
30
31 sysfs-rules
32 sysctl/index
33 cputopology
34 abi
35
36Security-related documentation:
37
38.. toctree::
39 :maxdepth: 1
40
41 hw-vuln/index
42 LSM/index
43 perf-security
44
45Booting the kernel
46------------------
47
48.. toctree::
49 :maxdepth: 1
50
51 bootconfig
52 kernel-parameters
53 efi-stub
54 initrd
55
56
57Tracking down and identifying problems
58--------------------------------------
59
60Here is a set of documents aimed at users who are trying to track down
61problems and bugs in particular.
62
63.. toctree::
64 :maxdepth: 1
65
66 reporting-issues
67 reporting-regressions
68 quickly-build-trimmed-linux
69 verify-bugs-and-bisect-regressions
70 bug-hunting
71 bug-bisect
72 tainted-kernels
73 ramoops
74 dynamic-debug-howto
75 init
76 kdump/index
77 perf/index
78 pstore-blk
79 clearing-warn-once
80 kernel-per-CPU-kthreads
81 lockup-watchdogs
82 RAS/index
83 sysrq
84
85
86Core-kernel subsystems
87----------------------
88
89These documents describe core-kernel administration interfaces that are
90likely to be of interest on almost any system.
91
92.. toctree::
93 :maxdepth: 1
94
95 cgroup-v2
96 cgroup-v1/index
97 cpu-load
98 mm/index
99 module-signing
100 namespaces/index
101 numastat
102 pm/index
103 syscall-user-dispatch
104
105Support for non-native binary formats. Note that some of these
106documents are ... old ...
107
108.. toctree::
109 :maxdepth: 1
110
111 binfmt-misc
112 java
113 mono
114
115
116Block-layer and filesystem administration
117-----------------------------------------
118
119.. toctree::
120 :maxdepth: 1
121
122 bcache
123 binderfs
124 blockdev/index
125 cifs/index
126 device-mapper/index
127 ext4
128 filesystem-monitoring
129 nfs/index
130 iostats
131 jfs
132 md
133 ufs
134 xfs
135
136Device-specific guides
137----------------------
138
139How to configure your hardware within your Linux system.
140
141.. toctree::
142 :maxdepth: 1
143
144 acpi/index
145 aoe/index
146 auxdisplay/index
147 braille-console
148 btmrvl
149 dell_rbu
150 edid
151 gpio/index
152 hw_random
153 laptops/index
154 lcd-panel-cgram
155 media/index
156 nvme-multipath
157 parport
158 pnp
159 rapidio
160 rtc
161 serial-console
162 svga
163 thermal/index
164 thunderbolt
165 vga-softcursor
166 video-output
167
168Workload analysis
169-----------------
170
171This is the beginning of a section with information of interest to
172application developers and system integrators doing analysis of the
173Linux kernel for safety critical applications. Documents supporting
174analysis of kernel interactions with applications, and key kernel
175subsystems expectations will be found here.
176
177.. toctree::
178 :maxdepth: 1
179
180 workload-tracing
181
182Everything else
183---------------
184
185A few hard-to-categorize and generally obsolete documents.
186
187.. toctree::
188 :maxdepth: 1
189
190 ldm
191 unicode
192
193.. only:: subproject and html
194
195 Indices
196 =======
197
198 * :ref:`genindex`