OpenE2K/qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

docs: standardize directory index to --- with overline

Browse Source 
Use a standard heading format for the index.rst file in a directory.
Using overlines makes it clear that individual documents can use e.g.
=== for chapter titles and --- for section titles, as suggested in the
Linux kernel guidelines[1].  They could do it anyway, because documents
included in a toctree are parsed separately and therefore are not tied
to the same conventions for headings.  However, keeping some consistency is
useful since sometimes files are included from multiple places.

[1] https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
This commit is contained in:
Paolo Bonzini 2021-09-07 16:01:28 +02:00
parent 8a1f7d299c
commit 06905f6402
7 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/about/index.rst
View File

@ -1,5 +1,6 @@
----------
About QEMU
==========
----------
QEMU is a generic and open source machine emulator and virtualizer.

3
docs/devel/index.rst
View File

@ -1,5 +1,6 @@
---------------------
Developer Information
=====================
---------------------
This section of the manual documents various parts of the internals of QEMU.
You only need to read it if you are interested in reading or

3
docs/interop/index.rst
View File

@ -1,5 +1,6 @@
------------------------------------------------
System Emulation Management and Interoperability
================================================
------------------------------------------------
This section of the manual contains documents and specifications that
are useful for making QEMU interoperate with other software.

3
docs/specs/index.rst
View File

@ -1,5 +1,6 @@
----------------------------------------------
System Emulation Guest Hardware Specifications
==============================================
----------------------------------------------
This section of the manual contains specifications of
guest hardware that is specific to QEMU.

3
docs/system/index.rst
View File

@ -1,5 +1,6 @@
----------------
System Emulation
================
----------------
This section of the manual is the overall guide for users using QEMU
for full system emulation (as opposed to user-mode emulation).

3
docs/tools/index.rst
View File

@ -1,5 +1,6 @@
-----
Tools
=====
-----
This section of the manual documents QEMU's "tools": its
command line utilities and other standalone programs.

3
docs/user/index.rst
View File

@ -1,5 +1,6 @@
-------------------
User Mode Emulation
===================
-------------------
This section of the manual is the overall guide for users using QEMU
for user-mode emulation. In this mode, QEMU can launch