docs: Clean up and organize the admin guide a bit

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>

Jonathan Corbet 9 years ago 7358bb2f 555af624

+45 -17

4 changed files

expand all

Documentation

admin-guide

index.rst

kernel-parameters.rst

sysfs-rules.rst

vga-softcursor.rst

+39 -11

Documentation/admin-guide/index.rst

··· 1 - Linux Kernel User's Documentation 2 - ================================= 1 + The Linux kernel user's and administrator's guide 2 + ================================================= 3 3 4 - Contents: 4 + The following is a collection of user-oriented documents that have been 5 + added to the kernel over time. There is, as yet, little overall order or 6 + organization here — this material was not written to be a single, coherent 7 + document! With luck things will improve quickly over time. 8 + 9 + This initial section contains overall information, including the README 10 + file describing the kernel as a whole, documentation on kernel parameters, 11 + etc. 5 12 6 13 .. toctree:: 7 - :maxdepth: 2 8 - :numbered: 14 + :maxdepth: 1 9 15 10 16 README 17 + kernel-parameters 18 + devices 19 + 20 + Here is a set of documents aimed at users who are trying to track down 21 + problems and bugs in particular. 22 + 23 + .. toctree:: 24 + :maxdepth: 1 25 + 11 26 reporting-bugs 27 + security-bugs 12 28 bug-hunting 13 29 oops-tracing 14 30 ramoops 15 - initrd 16 - init 17 31 dynamic-debug-howto 18 - security-bugs 19 - kernel-parameters 32 + init 33 + 34 + This is the beginning of a section with information of interest to 35 + application developers. Documents covering various aspects of the kernel 36 + ABI will be found here. 37 + 38 + .. toctree:: 39 + :maxdepth: 1 40 + 41 + sysfs-rules 42 + 43 + The rest of this manual consists of various unordered guides on how to 44 + configure specific aspects of kernel behavior to your liking. 45 + 46 + .. toctree:: 47 + :maxdepth: 1 48 + 49 + initrd 20 50 serial-console 21 51 braille-console 22 52 parport ··· 55 25 sysrq 56 26 unicode 57 27 vga-softcursor 58 - sysfs-rules 59 - devices 60 28 binfmt-misc 61 29 mono 62 30 java

+2 -2

Documentation/admin-guide/kernel-parameters.rst

··· 1 - Kernel Parameters 2 - ~~~~~~~~~~~~~~~~~ 1 + The kernel's command-line parameters 2 + ==================================== 3 3 4 4 The following is a consolidated list of the kernel parameters as 5 5 implemented by the __setup(), core_param() and module_param() macros

+2 -2

Documentation/admin-guide/sysfs-rules.rst

··· 1 - Rules on how to access information in the Linux kernel sysfs 2 - ============================================================ 1 + Rules on how to access information in sysfs 2 + =========================================== 3 3 4 4 The kernel-exported sysfs exports internal kernel implementation details 5 5 and depends on internal kernel structures and layout. It is agreed upon

+2 -2

Documentation/admin-guide/vga-softcursor.rst

··· 50 50 51 51 .. [#f1] see ``#define TRIDENT_GLITCH`` in ``drivers/video/vgacon.c``. 52 52 53 - Examples: 54 - ========= 53 + Examples 54 + -------- 55 55 56 56 To get normal blinking underline, use:: 57 57

Configure Feed

Configure Feed