summaryrefslogtreecommitdiffstats
path: root/Documentation/admin-guide/index.rst
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2016-10-27 17:05:10 -0600
committerJonathan Corbet <corbet@lwn.net>2016-10-27 17:47:58 -0600
commit9d2cccdd6c226181c42a7bb0c5ede1583687b618 (patch)
tree993ff17c35fd23a71533e63f6943b9bf59e1d5e4 /Documentation/admin-guide/index.rst
parent2797cd03f5cca4d9fb2875c9f9c995737ce73469 (diff)
parent67972a539e9ff1a3ed794c463c4e544442df693e (diff)
downloadblackbird-op-linux-9d2cccdd6c226181c42a7bb0c5ede1583687b618.tar.gz
blackbird-op-linux-9d2cccdd6c226181c42a7bb0c5ede1583687b618.zip
Merge branch 'doc-tweaks' into docs-next
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.
Diffstat (limited to 'Documentation/admin-guide/index.rst')
-rw-r--r--Documentation/admin-guide/index.rst53
1 files changed, 39 insertions, 14 deletions
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index fb779e67097b..368845e9900a 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -1,22 +1,52 @@
-Linux Kernel User's Documentation
-=================================
+The Linux kernel user's and administrator's guide
+=================================================
-Contents:
+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: 2
- :numbered:
+ :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
- initrd
- init
dynamic-debug-howto
- security-bugs
- kernel-parameters
+ 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
@@ -25,13 +55,9 @@ Contents:
sysrq
unicode
vga-softcursor
- sysfs-rules
- devices
binfmt-misc
mono
java
- bad-memory
- basic-profiling
.. only:: subproject and html
@@ -39,4 +65,3 @@ Contents:
=======
* :ref:`genindex`
-
OpenPOWER on IntegriCloud