Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / refs/heads/master / . / Documentation / admin-guide / index.rst
blob: 1bedab498104af95a2f52257fe0ee728276fc092 [file] [log] [blame]
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]1The Linux kernel user's and administrator's guide
2=================================================
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]3
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]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,
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]11etc.
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]12
13.. toctree::
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]14 :maxdepth: 1
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]15
16 README
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]17 kernel-parameters
18 devices
Mauro Carvalho Chehab57043242019-04-22 16:48:00 -0300[diff] [blame]19 sysctl/index
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]20
Mauro Carvalho Chehaba7ee04b2020-10-30 08:40:36 +0100[diff] [blame]21 abi
Mauro Carvalho Chehab63fdc462020-11-30 16:36:34 +0100[diff] [blame]22 features
Mauro Carvalho Chehaba7ee04b2020-10-30 08:40:36 +0100[diff] [blame]23
Thomas Gleixner65fd4cb2019-02-19 11:10:49 +0100[diff] [blame]24This section describes CPU vulnerabilities and their mitigations.
Thomas Gleixner3ec8ce52018-07-13 16:23:26 +0200[diff] [blame]25
26.. toctree::
27 :maxdepth: 1
28
Thomas Gleixner65fd4cb2019-02-19 11:10:49 +0100[diff] [blame]29 hw-vuln/index
Thomas Gleixner3ec8ce52018-07-13 16:23:26 +0200[diff] [blame]30
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]31Here is a set of documents aimed at users who are trying to track down
32problems and bugs in particular.
33
34.. toctree::
35 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]36
Thorsten Leemhuis3e544d72020-12-04 07:43:49 +0100[diff] [blame]37 reporting-issues
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]38 security-bugs
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]39 bug-hunting
Mauro Carvalho Chehabc7309042016-11-07 17:03:17 -0200[diff] [blame]40 bug-bisect
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]41 tainted-kernels
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]42 ramoops
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]43 dynamic-debug-howto
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]44 init
Mauro Carvalho Chehab330d4812019-06-13 15:21:39 -0300[diff] [blame]45 kdump/index
Mauro Carvalho Chehab59809fe2019-06-18 16:06:08 -0300[diff] [blame]46 perf/index
Daniel W. S. Almeida00d7c1e2020-07-18 13:51:03 -0300[diff] [blame]47 pstore-blk
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]48
49This is the beginning of a section with information of interest to
50application developers. Documents covering various aspects of the kernel
51ABI will be found here.
52
53.. toctree::
54 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]55
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]56 sysfs-rules
57
58The rest of this manual consists of various unordered guides on how to
59configure specific aspects of kernel behavior to your liking.
60
61.. toctree::
62 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]63
Changbin Du680e6ff2019-04-25 23:30:54 +0800[diff] [blame]64 acpi/index
Mauro Carvalho Chehab83bbf6e2019-06-27 12:59:40 -0300[diff] [blame]65 aoe/index
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]66 auxdisplay/index
67 bcache
68 binderfs
69 binfmt-misc
70 blockdev/index
Masami Hiramatsu7b9b8162020-01-11 01:05:06 +0900[diff] [blame]71 bootconfig
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]72 braille-console
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]73 btmrvl
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]74 cgroup-v1/index
75 cgroup-v2
76 cifs/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]77 clearing-warn-once
78 cpu-load
79 cputopology
Jonathan Neuschäferd4300c42019-10-12 19:11:10 +0200[diff] [blame]80 dell_rbu
Mauro Carvalho Chehab6cf2a732019-06-18 12:40:23 -0300[diff] [blame]81 device-mapper/index
Jonathan Neuschäfer320bfd92020-02-14 18:41:33 +0100[diff] [blame]82 edid
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]83 efi-stub
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]84 ext4
Gabriel Krisman Bertazic0baf9a2021-10-25 16:27:46 -0300[diff] [blame]85 filesystem-monitoring
Daniel W. S. Almeida2f123b9a2020-01-10 20:24:23 -0300[diff] [blame]86 nfs/index
Mauro Carvalho Chehabc2746a12019-06-28 08:14:42 -0300[diff] [blame]87 gpio/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]88 highuid
89 hw_random
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]90 initrd
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]91 iostats
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]92 java
93 jfs
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]94 kernel-per-CPU-kthreads
Mauro Carvalho Chehab9e1cbed2019-06-13 15:07:43 -0300[diff] [blame]95 laptops/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]96 lcd-panel-cgram
97 ldm
98 lockup-watchdogs
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]99 LSM/index
100 md
Mauro Carvalho Chehab32e2eae2020-03-04 13:08:03 +0100[diff] [blame]101 media/index
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]102 mm/index
103 module-signing
104 mono
105 namespaces/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]106 numastat
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]107 parport
108 perf-security
109 pm/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]110 pnp
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]111 rapidio
112 ras
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]113 rtc
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]114 serial-console
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]115 svga
Gabriel Krisman Bertazia4452e62020-11-27 14:32:38 -0500[diff] [blame]116 syscall-user-dispatch
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]117 sysrq
118 thunderbolt
119 ufs
120 unicode
121 vga-softcursor
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]122 video-output
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame]123 xfs
Markus Heiser6f2ec3a2016-10-26 08:23:16 +0200[diff] [blame]124
125.. only:: subproject and html
126
127 Indices
128 =======
129
130 * :ref:`genindex`