xref: /OK3568_Linux_fs/kernel/Documentation/admin-guide/index.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunThe Linux kernel user's and administrator's guide
2*4882a593Smuzhiyun=================================================
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunThe following is a collection of user-oriented documents that have been
5*4882a593Smuzhiyunadded to the kernel over time.  There is, as yet, little overall order or
6*4882a593Smuzhiyunorganization here — this material was not written to be a single, coherent
7*4882a593Smuzhiyundocument!  With luck things will improve quickly over time.
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunThis initial section contains overall information, including the README
10*4882a593Smuzhiyunfile describing the kernel as a whole, documentation on kernel parameters,
11*4882a593Smuzhiyunetc.
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun.. toctree::
14*4882a593Smuzhiyun   :maxdepth: 1
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun   README
17*4882a593Smuzhiyun   kernel-parameters
18*4882a593Smuzhiyun   devices
19*4882a593Smuzhiyun   sysctl/index
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun   abi
22*4882a593Smuzhiyun
23*4882a593SmuzhiyunThis section describes CPU vulnerabilities and their mitigations.
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun.. toctree::
26*4882a593Smuzhiyun   :maxdepth: 1
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun   hw-vuln/index
29*4882a593Smuzhiyun
30*4882a593SmuzhiyunHere is a set of documents aimed at users who are trying to track down
31*4882a593Smuzhiyunproblems and bugs in particular.
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun.. toctree::
34*4882a593Smuzhiyun   :maxdepth: 1
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun   reporting-bugs
37*4882a593Smuzhiyun   security-bugs
38*4882a593Smuzhiyun   bug-hunting
39*4882a593Smuzhiyun   bug-bisect
40*4882a593Smuzhiyun   tainted-kernels
41*4882a593Smuzhiyun   ramoops
42*4882a593Smuzhiyun   dynamic-debug-howto
43*4882a593Smuzhiyun   init
44*4882a593Smuzhiyun   kdump/index
45*4882a593Smuzhiyun   perf/index
46*4882a593Smuzhiyun   pstore-blk
47*4882a593Smuzhiyun
48*4882a593SmuzhiyunThis is the beginning of a section with information of interest to
49*4882a593Smuzhiyunapplication developers.  Documents covering various aspects of the kernel
50*4882a593SmuzhiyunABI will be found here.
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun.. toctree::
53*4882a593Smuzhiyun   :maxdepth: 1
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun   sysfs-rules
56*4882a593Smuzhiyun
57*4882a593SmuzhiyunThe rest of this manual consists of various unordered guides on how to
58*4882a593Smuzhiyunconfigure specific aspects of kernel behavior to your liking.
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun.. toctree::
61*4882a593Smuzhiyun   :maxdepth: 1
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun   acpi/index
64*4882a593Smuzhiyun   aoe/index
65*4882a593Smuzhiyun   auxdisplay/index
66*4882a593Smuzhiyun   bcache
67*4882a593Smuzhiyun   binderfs
68*4882a593Smuzhiyun   binfmt-misc
69*4882a593Smuzhiyun   blockdev/index
70*4882a593Smuzhiyun   bootconfig
71*4882a593Smuzhiyun   braille-console
72*4882a593Smuzhiyun   btmrvl
73*4882a593Smuzhiyun   cgroup-v1/index
74*4882a593Smuzhiyun   cgroup-v2
75*4882a593Smuzhiyun   cifs/index
76*4882a593Smuzhiyun   clearing-warn-once
77*4882a593Smuzhiyun   cpu-load
78*4882a593Smuzhiyun   cputopology
79*4882a593Smuzhiyun   dell_rbu
80*4882a593Smuzhiyun   device-mapper/index
81*4882a593Smuzhiyun   edid
82*4882a593Smuzhiyun   efi-stub
83*4882a593Smuzhiyun   ext4
84*4882a593Smuzhiyun   nfs/index
85*4882a593Smuzhiyun   gpio/index
86*4882a593Smuzhiyun   highuid
87*4882a593Smuzhiyun   hw_random
88*4882a593Smuzhiyun   initrd
89*4882a593Smuzhiyun   iostats
90*4882a593Smuzhiyun   java
91*4882a593Smuzhiyun   jfs
92*4882a593Smuzhiyun   kernel-per-CPU-kthreads
93*4882a593Smuzhiyun   laptops/index
94*4882a593Smuzhiyun   lcd-panel-cgram
95*4882a593Smuzhiyun   ldm
96*4882a593Smuzhiyun   lockup-watchdogs
97*4882a593Smuzhiyun   LSM/index
98*4882a593Smuzhiyun   md
99*4882a593Smuzhiyun   media/index
100*4882a593Smuzhiyun   mm/index
101*4882a593Smuzhiyun   module-signing
102*4882a593Smuzhiyun   mono
103*4882a593Smuzhiyun   namespaces/index
104*4882a593Smuzhiyun   numastat
105*4882a593Smuzhiyun   parport
106*4882a593Smuzhiyun   perf-security
107*4882a593Smuzhiyun   pm/index
108*4882a593Smuzhiyun   pnp
109*4882a593Smuzhiyun   rapidio
110*4882a593Smuzhiyun   ras
111*4882a593Smuzhiyun   rtc
112*4882a593Smuzhiyun   serial-console
113*4882a593Smuzhiyun   svga
114*4882a593Smuzhiyun   sysrq
115*4882a593Smuzhiyun   thunderbolt
116*4882a593Smuzhiyun   ufs
117*4882a593Smuzhiyun   unicode
118*4882a593Smuzhiyun   vga-softcursor
119*4882a593Smuzhiyun   video-output
120*4882a593Smuzhiyun   wimax/index
121*4882a593Smuzhiyun   xfs
122*4882a593Smuzhiyun
123*4882a593Smuzhiyun.. only::  subproject and html
124*4882a593Smuzhiyun
125*4882a593Smuzhiyun   Indices
126*4882a593Smuzhiyun   =======
127*4882a593Smuzhiyun
128*4882a593Smuzhiyun   * :ref:`genindex`
129