[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 10/21] docs: standardize directory index to --- with overline
From: |
Paolo Bonzini |
Subject: |
[PULL 10/21] docs: standardize directory index to --- with overline |
Date: |
Mon, 13 Sep 2021 13:57:31 +0200 |
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>
---
docs/about/index.rst | 3 ++-
docs/devel/index.rst | 3 ++-
docs/interop/index.rst | 3 ++-
docs/specs/index.rst | 3 ++-
docs/system/index.rst | 3 ++-
docs/tools/index.rst | 3 ++-
docs/user/index.rst | 3 ++-
7 files changed, 14 insertions(+), 7 deletions(-)
diff --git a/docs/about/index.rst b/docs/about/index.rst
index beb762aa0a..5bea653c07 100644
--- 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 5522db7241..f95df10b3e 100644
--- 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 f9801a9c20..47b9ed82bb 100644
--- 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 65e9663916..ecc43896bb 100644
--- 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 7b9276c05f..73bbedbc22 100644
--- 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 ef6041a490..1edd5a8054 100644
--- 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 9faa4badd7..2c4e29f3db 100644
--- 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
--
2.31.1
- [PULL 00/21] x86, docs, meson changes for 2021-09-13, Paolo Bonzini, 2021/09/13
- [PULL 01/21] target/i386: add missing bits to CR4_RESERVED_MASK, Paolo Bonzini, 2021/09/13
- [PULL 02/21] target/i386: VMRUN and VMLOAD canonicalizations, Paolo Bonzini, 2021/09/13
- [PULL 03/21] target/i386: Added VGIF feature, Paolo Bonzini, 2021/09/13
- [PULL 08/21] target/i386: Added vVMLOAD and vVMSAVE feature, Paolo Bonzini, 2021/09/13
- [PULL 10/21] docs: standardize directory index to --- with overline,
Paolo Bonzini <=
- [PULL 11/21] docs/system: standardize man page sections to --- with overline, Paolo Bonzini, 2021/09/13
- [PULL 06/21] target/i386: Added ignore TPR check in ctl_has_irq, Paolo Bonzini, 2021/09/13
- [PULL 09/21] docs: standardize book titles to === with overline, Paolo Bonzini, 2021/09/13
- [PULL 12/21] docs/system: move x86 CPU configuration to a separate document, Paolo Bonzini, 2021/09/13
- [PULL 19/21] Only check CONFIG_NVMM when NEED_CPU_H is defined, Paolo Bonzini, 2021/09/13
- [PULL 04/21] target/i386: Moved int_ctl into CPUX86State structure, Paolo Bonzini, 2021/09/13
- [PULL 14/21] meson: look up cp and dtrace with find_program(), Paolo Bonzini, 2021/09/13
- [PULL 16/21] meson: remove dead variable, Paolo Bonzini, 2021/09/13
- [PULL 07/21] target/i386: Added changed priority check for VIRQ, Paolo Bonzini, 2021/09/13
- [PULL 05/21] target/i386: Added VGIF V_IRQ masking capability, Paolo Bonzini, 2021/09/13