docs: standardize directory index to --- with overline

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>

diff --git a/docs/about/index.rst b/docs/about/index.rst
index beb762aa0a9dda20b76701b522808885ffa0bcd4..5bea653c07cf1465dea7ee0e5eab59987c7c1ac6 100644 (file)
--- a/docs/about/index.rst
+++ b/docs/about/index.rst
@@ -1,5 +1,6 @@
+----------
 About QEMU
-==========
+----------
 
 QEMU is a generic and open source machine emulator and virtualizer.
 

diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index 5522db72411f75ba713c569758ed80037f8dfed0..f95df10b3eb1ee4177f0fca9767f41c793951ab3 100644 (file)
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -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

diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index f9801a9c202b6ab510b942640e44381052a80bbf..47b9ed82bbc039c5e6739843248a120157c0f870 100644 (file)
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -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.

diff --git a/docs/specs/index.rst b/docs/specs/index.rst
index 65e9663916af1fcfad07e7edc6c4bf8d3e0ae3e8..ecc43896bb21d8cd257cb0f0ff7229020d9c5db1 100644 (file)
--- a/docs/specs/index.rst
+++ b/docs/specs/index.rst
@@ -1,5 +1,6 @@
+----------------------------------------------
 System Emulation Guest Hardware Specifications
-==============================================
+----------------------------------------------
 
 This section of the manual contains specifications of
 guest hardware that is specific to QEMU.

diff --git a/docs/system/index.rst b/docs/system/index.rst
index 7b9276c05f0de46634c88d84dad8229eb4f68315..73bbedbc22d495d9557f8989caf0ebf023d36b55 100644 (file)
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -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).

diff --git a/docs/tools/index.rst b/docs/tools/index.rst
index ef6041a490f365394194db4764bd50761422e4d5..1edd5a8054a6eb98bf4debd57b8a8d0caaaee2a1 100644 (file)
--- a/docs/tools/index.rst
+++ b/docs/tools/index.rst
@@ -1,5 +1,6 @@
+-----
 Tools
-=====
+-----
 
 This section of the manual documents QEMU's "tools": its
 command line utilities and other standalone programs.

diff --git a/docs/user/index.rst b/docs/user/index.rst
index 9faa4badd78f90c2872a2ac126c834d852e9b687..2c4e29f3dbc34f5ee95570362d1279a6bf2ebeef 100644 (file)
--- a/docs/user/index.rst
+++ b/docs/user/index.rst
@@ -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