7358bb2f32
The admin guide is a good start, but it's time to turn it into something better than an unordered blob of files. This is a first step in that direction. The TOC has been split up and annotated, the guides have been reordered, and minor tweaks have been applied to a few of them. One consequence of splitting up the TOC is that we don't really want to use :numbered: anymore, since the count resets every time and there doesn't seem to be a way to change that. Eventually we probably want to group the documents into sub-books, at which point we can go back to a single TOC, but it's probably early to do that. Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
63 lines
1.4 KiB
ReStructuredText
63 lines
1.4 KiB
ReStructuredText
The Linux kernel user's and administrator's guide
|
|
=================================================
|
|
|
|
The following is a collection of user-oriented documents that have been
|
|
added to the kernel over time. There is, as yet, little overall order or
|
|
organization here — this material was not written to be a single, coherent
|
|
document! With luck things will improve quickly over time.
|
|
|
|
This initial section contains overall information, including the README
|
|
file describing the kernel as a whole, documentation on kernel parameters,
|
|
etc.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
README
|
|
kernel-parameters
|
|
devices
|
|
|
|
Here is a set of documents aimed at users who are trying to track down
|
|
problems and bugs in particular.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
reporting-bugs
|
|
security-bugs
|
|
bug-hunting
|
|
oops-tracing
|
|
ramoops
|
|
dynamic-debug-howto
|
|
init
|
|
|
|
This is the beginning of a section with information of interest to
|
|
application developers. Documents covering various aspects of the kernel
|
|
ABI will be found here.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
sysfs-rules
|
|
|
|
The rest of this manual consists of various unordered guides on how to
|
|
configure specific aspects of kernel behavior to your liking.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
initrd
|
|
serial-console
|
|
braille-console
|
|
parport
|
|
md
|
|
module-signing
|
|
sysrq
|
|
unicode
|
|
vga-softcursor
|
|
binfmt-misc
|
|
mono
|
|
java
|
|
bad-memory
|
|
basic-profiling
|