Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / kernel / shift / mainline / f2381f652266fabfb7a8f5c4b2a05de36cad3a73 / . / Documentation / admin-guide / index.rst
blob: 5bb9161dbe6a31be54992d412945289ce3a57587 [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
19
20Here is a set of documents aimed at users who are trying to track down
21problems and bugs in particular.
22
23.. toctree::
24 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]25
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]26 reporting-bugs
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]27 security-bugs
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]28 bug-hunting
Mauro Carvalho Chehabc7309042016-11-07 17:03:17 -0200[diff] [blame]29 bug-bisect
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]30 tainted-kernels
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]31 ramoops
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]32 dynamic-debug-howto
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]33 init
34
35This is the beginning of a section with information of interest to
36application developers. Documents covering various aspects of the kernel
37ABI will be found here.
38
39.. toctree::
40 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]41
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]42 sysfs-rules
43
44The rest of this manual consists of various unordered guides on how to
45configure specific aspects of kernel behavior to your liking.
46
47.. toctree::
48 :maxdepth: 1
Mauro Carvalho Chehab337c1882016-11-07 17:03:18 -0200[diff] [blame]49
Jonathan Corbet7358bb22016-10-26 16:14:52 -0600[diff] [blame]50 initrd
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]51 serial-console
52 braille-console
53 parport
54 md
55 module-signing
56 sysrq
57 unicode
58 vga-softcursor
Mauro Carvalho Chehab9d850252016-09-21 09:51:11 -0300[diff] [blame]59 binfmt-misc
60 mono
61 java
Mauro Carvalho Chehabfd77f6b2016-10-26 16:24:41 -0200[diff] [blame]62 ras
Rafael J. Wysocki2a0e4922017-03-13 23:59:57 +0100[diff] [blame]63 pm/index
Mika Westerberg163f1512017-06-06 15:25:18 +0300[diff] [blame]64 thunderbolt
Kees Cook504f2312017-05-13 04:51:43 -0700[diff] [blame]65 LSM/index
Markus Heiser6f2ec3a2016-10-26 08:23:16 +0200[diff] [blame]66
67.. only:: subproject and html
68
69 Indices
70 =======
71
72 * :ref:`genindex`