mirror of
https://github.com/torvalds/linux.git
synced 2024-11-22 12:11:40 +00:00
9d2cccdd6c
The creation of the admin and process guides is a great thing, but, without care, we risk replacing a messy docs directory with a few messy Sphinx books. In an attempt to head that off and show what I'm thinking, here's a set of tweaks that, I think, make the existing Sphinx-formatted docs a bit more accessible.
68 lines
1.4 KiB
ReStructuredText
68 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
|
|
|
|
.. only:: subproject and html
|
|
|
|
Indices
|
|
=======
|
|
|
|
* :ref:`genindex`
|