[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 09/21] docs: standardize book titles to === with overline
From: |
Paolo Bonzini |
Subject: |
[PULL 09/21] docs: standardize book titles to === with overline |
Date: |
Mon, 13 Sep 2021 13:57:30 +0200 |
Documents within a Sphinx manual are separate files and therefore can use
different conventions for headings. However, keeping some consistency is
useful so that included files are easy to get right.
This patch uses a standard heading format for book titles, so that it is
obvious when a file sits at the top level toctree of a book or man page.
The heading is irrelevant for man pages, but keep it consistent as well.
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
docs/index.rst | 1 +
docs/system/qemu-block-drivers.rst | 1 +
docs/system/qemu-cpu-models.rst | 1 +
docs/system/qemu-manpage.rst | 5 +++--
docs/tools/qemu-img.rst | 1 +
docs/tools/qemu-nbd.rst | 1 +
docs/tools/qemu-pr-helper.rst | 1 +
docs/tools/qemu-storage-daemon.rst | 1 +
docs/tools/qemu-trace-stap.rst | 1 +
9 files changed, 11 insertions(+), 2 deletions(-)
diff --git a/docs/index.rst b/docs/index.rst
index 5f7eaaa632..0b9ee9901d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,6 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
+================================
Welcome to QEMU's documentation!
================================
diff --git a/docs/system/qemu-block-drivers.rst
b/docs/system/qemu-block-drivers.rst
index bd99d4fa8e..eb276481d6 100644
--- a/docs/system/qemu-block-drivers.rst
+++ b/docs/system/qemu-block-drivers.rst
@@ -1,5 +1,6 @@
:orphan:
+============================
QEMU block drivers reference
============================
diff --git a/docs/system/qemu-cpu-models.rst b/docs/system/qemu-cpu-models.rst
index 53d7538c47..8c51e2bf49 100644
--- a/docs/system/qemu-cpu-models.rst
+++ b/docs/system/qemu-cpu-models.rst
@@ -1,5 +1,6 @@
:orphan:
+==================================
QEMU / KVM CPU model configuration
==================================
diff --git a/docs/system/qemu-manpage.rst b/docs/system/qemu-manpage.rst
index e9a25d0680..d6f44e265b 100644
--- a/docs/system/qemu-manpage.rst
+++ b/docs/system/qemu-manpage.rst
@@ -6,8 +6,9 @@
parts of the documentation that go in the manpage as well as the
HTML manual.
-Title
-=====
+=======================
+QEMU User Documentation
+=======================
Synopsis
--------
diff --git a/docs/tools/qemu-img.rst b/docs/tools/qemu-img.rst
index b7d602a288..fe6c30d509 100644
--- a/docs/tools/qemu-img.rst
+++ b/docs/tools/qemu-img.rst
@@ -1,3 +1,4 @@
+=======================
QEMU disk image utility
=======================
diff --git a/docs/tools/qemu-nbd.rst b/docs/tools/qemu-nbd.rst
index ee862fa0bc..e39a9f4b1a 100644
--- a/docs/tools/qemu-nbd.rst
+++ b/docs/tools/qemu-nbd.rst
@@ -1,3 +1,4 @@
+=====================================
QEMU Disk Network Block Device Server
=====================================
diff --git a/docs/tools/qemu-pr-helper.rst b/docs/tools/qemu-pr-helper.rst
index ac036180ac..eaebe40da0 100644
--- a/docs/tools/qemu-pr-helper.rst
+++ b/docs/tools/qemu-pr-helper.rst
@@ -1,3 +1,4 @@
+==================================
QEMU persistent reservation helper
==================================
diff --git a/docs/tools/qemu-storage-daemon.rst
b/docs/tools/qemu-storage-daemon.rst
index 3ec4bdd914..b8ef4486f1 100644
--- a/docs/tools/qemu-storage-daemon.rst
+++ b/docs/tools/qemu-storage-daemon.rst
@@ -1,3 +1,4 @@
+===================
QEMU Storage Daemon
===================
diff --git a/docs/tools/qemu-trace-stap.rst b/docs/tools/qemu-trace-stap.rst
index fb70445c75..d53073b52b 100644
--- a/docs/tools/qemu-trace-stap.rst
+++ b/docs/tools/qemu-trace-stap.rst
@@ -1,3 +1,4 @@
+=========================
QEMU SystemTap trace tool
=========================
--
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, 2021/09/13
- [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 <=
- [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
- [PULL 13/21] meson.build: Do not look for VNC-related libraries if have_system is not set, Paolo Bonzini, 2021/09/13
- [PULL 17/21] fw_cfg: add etc/msr_feature_control, Paolo Bonzini, 2021/09/13
- [PULL 15/21] meson: do not use python.full_path() unnecessarily, Paolo Bonzini, 2021/09/13