Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / kernel / common / 2c1d7ffdf4fe34b79a373ea93584e71ae6ce62e2 / . / Documentation / admin-guide / index.rst
blob: 545ea26364b7656004cc9ef8ebae348a4cc21f79 [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
Thomas Gleixner65fd4cb2019-02-19 11:10:49 +0100[diff] [blame]21This section describes CPU vulnerabilities and their mitigations.
Thomas Gleixner3ec8ce52018-07-13 16:23:26 +0200[diff] [blame]22
23.. toctree::
24 :maxdepth: 1
25
Thomas Gleixner65fd4cb2019-02-19 11:10:49 +0100[diff] [blame]26 hw-vuln/index
Thomas Gleixner3ec8ce52018-07-13 16:23:26 +0200[diff] [blame]27
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]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
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]33
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]34 reporting-bugs
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]35 security-bugs
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]36 bug-hunting
Mauro Carvalho Chehabc7309042016-11-07 17:03:17 -0200[diff] [blame]37 bug-bisect
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]38 tainted-kernels
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]39 ramoops
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]40 dynamic-debug-howto
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]41 init
Mauro Carvalho Chehab330d4812019-06-13 15:21:39 -0300[diff] [blame]42 kdump/index
Mauro Carvalho Chehab59809fe2019-06-18 16:06:08 -0300[diff] [blame]43 perf/index
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]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
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]51
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]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
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]59
Changbin Du680e6ff2019-04-25 23:30:54 +0800[diff] [blame]60 acpi/index
Mauro Carvalho Chehab83bbf6e2019-06-27 12:59:40 -0300[diff] [blame]61 aoe/index
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]62 auxdisplay/index
63 bcache
64 binderfs
65 binfmt-misc
66 blockdev/index
67 braille-console
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]68 btmrvl
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]69 cgroup-v1/index
70 cgroup-v2
71 cifs/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]72 clearing-warn-once
73 cpu-load
74 cputopology
Mauro Carvalho Chehab6cf2a732019-06-18 12:40:23 -0300[diff] [blame]75 device-mapper/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]76 efi-stub
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]77 ext4
Mauro Carvalho Chehabc2746a12019-06-28 08:14:42 -0300[diff] [blame]78 gpio/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]79 highuid
80 hw_random
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]81 initrd
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]82 iostats
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]83 java
84 jfs
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]85 kernel-per-CPU-kthreads
Mauro Carvalho Chehab9e1cbed2019-06-13 15:07:43 -0300[diff] [blame]86 laptops/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]87 lcd-panel-cgram
88 ldm
89 lockup-watchdogs
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]90 LSM/index
91 md
92 mm/index
93 module-signing
94 mono
95 namespaces/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]96 numastat
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]97 parport
98 perf-security
99 pm/index
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]100 pnp
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]101 rapidio
102 ras
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]103 rtc
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]104 serial-console
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]105 svga
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]106 sysrq
107 thunderbolt
108 ufs
109 unicode
110 vga-softcursor
Mauro Carvalho Chehab4f4cfa62019-06-27 14:56:51 -0300[diff] [blame]111 video-output
Jonathan Neuschäfer2c1d7ff2019-10-12 19:11:09 +0200[diff] [blame^]112 wimax/index
113 xfs
Markus Heiser6f2ec3a2016-10-26 08:23:16 +0200[diff] [blame]114
115.. only:: subproject and html
116
117 Indices
118 =======
119
120 * :ref:`genindex`