]> www.infradead.org Git - users/dwmw2/qemu.git/commitdiff
docs: standardize book titles to === with overline
authorPaolo Bonzini <pbonzini@redhat.com>
Tue, 7 Sep 2021 13:58:12 +0000 (15:58 +0200)
committerPaolo Bonzini <pbonzini@redhat.com>
Mon, 13 Sep 2021 11:56:26 +0000 (13:56 +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
docs/system/qemu-block-drivers.rst
docs/system/qemu-cpu-models.rst
docs/system/qemu-manpage.rst
docs/tools/qemu-img.rst
docs/tools/qemu-nbd.rst
docs/tools/qemu-pr-helper.rst
docs/tools/qemu-storage-daemon.rst
docs/tools/qemu-trace-stap.rst

index 5f7eaaa632c4e1e4569bd9996801f071de1b0fe7..0b9ee9901d952c37cf3f9aefeffcaababea0c2d7 100644 (file)
@@ -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!
 ================================
 
index bd99d4fa8eba9e2306d81ff3675cea2f00296a46..eb276481d61c18de26df02c938f595a6a05c0f83 100644 (file)
@@ -1,5 +1,6 @@
 :orphan:
 
+============================
 QEMU block drivers reference
 ============================
 
index 53d7538c473af44311b21ac033cffb65b3a59465..8c51e2bf49a8d02610e4bd1ec85d55574c747aff 100644 (file)
@@ -1,5 +1,6 @@
 :orphan:
 
+==================================
 QEMU / KVM CPU model configuration
 ==================================
 
index e9a25d0680fe0bea3f07915d9ca6b9c3975944a1..d6f44e265bec04a722394f0b9bbf5610ea0ba3d4 100644 (file)
@@ -6,8 +6,9 @@
    parts of the documentation that go in the manpage as well as the
    HTML manual.
 
-Title
-=====
+=======================
+QEMU User Documentation
+=======================
 
 Synopsis
 --------
index b7d602a2880406ea5d87218e78c524823a2fb3c7..fe6c30d5093659e656d269ad26ce583e4e353f17 100644 (file)
@@ -1,3 +1,4 @@
+=======================
 QEMU disk image utility
 =======================
 
index ee862fa0bc02667bb67f99447b2311bf355e406d..e39a9f4b1a67878d6ec47977e7ca6bf9f29c549b 100644 (file)
@@ -1,3 +1,4 @@
+=====================================
 QEMU Disk Network Block Device Server
 =====================================
 
index ac036180ac1e22bc82d3928b1a2796916b031e4e..eaebe40da0ea2bdbb1568df43275381fc971187c 100644 (file)
@@ -1,3 +1,4 @@
+==================================
 QEMU persistent reservation helper
 ==================================
 
index 3ec4bdd9145a6f4cf876981788d85a8209d3d5cc..b8ef4486f1e73998823d8ca1e23fd26435e7a9d8 100644 (file)
@@ -1,3 +1,4 @@
+===================
 QEMU Storage Daemon
 ===================
 
index fb70445c751e625e5ad6b50e453acb15071beea5..d53073b52b66282610dcb9e237f7c3979be1c059 100644 (file)
@@ -1,3 +1,4 @@
+=========================
 QEMU SystemTap trace tool
 =========================