[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL v4 37/43] docs: standardize book titles to === with overline
From: |
Paolo Bonzini |
Subject: |
[PULL v4 37/43] docs: standardize book titles to === with overline |
Date: |
Wed, 8 Sep 2021 12:04:20 +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
- Re: [PULL v4 36/43] sgx-epc: Add the fill_device_info() callback support, (continued)
- [PULL v4 40/43] docs/system: move x86 CPU configuration to a separate document, Paolo Bonzini, 2021/09/08
- [PULL v4 39/43] docs/system: standardize man page sections to --- with overline, Paolo Bonzini, 2021/09/08
- [PULL v4 23/43] i386: Propagate SGX CPUID sub-leafs to KVM, Paolo Bonzini, 2021/09/08
- [PULL v4 25/43] hw/i386/fw_cfg: Set SGX bits in feature control fw_cfg accordingly, Paolo Bonzini, 2021/09/08
- [PULL v4 28/43] i386: acpi: Add SGX EPC entry to ACPI tables, Paolo Bonzini, 2021/09/08
- [PULL v4 26/43] hw/i386/pc: Account for SGX EPC sections when calculating device memory, Paolo Bonzini, 2021/09/08
- [PULL v4 29/43] q35: Add support for SGX EPC, Paolo Bonzini, 2021/09/08
- [PULL v4 31/43] hostmem-epc: Add the reset interface for EPC backend reset, Paolo Bonzini, 2021/09/08
- [PULL v4 33/43] sgx-epc: Avoid bios reset during sgx epc initialization, Paolo Bonzini, 2021/09/08
- [PULL v4 37/43] docs: standardize book titles to === with overline,
Paolo Bonzini <=
- [PULL v4 34/43] hostmem-epc: Make prealloc consistent with qemu cmdline during reset, Paolo Bonzini, 2021/09/08
- [PULL v4 35/43] Kconfig: Add CONFIG_SGX support, Paolo Bonzini, 2021/09/08
- [PULL v4 38/43] docs: standardize directory index to --- with overline, Paolo Bonzini, 2021/09/08
- [PULL v4 41/43] docs/system: Add SGX documentation to the system manual, Paolo Bonzini, 2021/09/08
- [PULL v4 16/43] i386: Add SGX CPUID leaf FEAT_SGX_12_0_EBX, Paolo Bonzini, 2021/09/08
- [PULL v4 30/43] i440fx: Add support for SGX EPC, Paolo Bonzini, 2021/09/08
- [PULL v4 20/43] i386: Add feature control MSR dependency when SGX is enabled, Paolo Bonzini, 2021/09/08
- [PULL v4 42/43] meson.build: Do not look for VNC-related libraries if have_system is not set, Paolo Bonzini, 2021/09/08