Pārlūkot izejas kodu

docs: standardize book titles to === with overline

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>
Paolo Bonzini 4 gadi atpakaļ
vecāks
revīzija
8a1f7d299c

+ 1 - 0
docs/index.rst

@@ -3,6 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
    contain the root `toctree` directive.
 
 
+================================
 Welcome to QEMU's documentation!
 Welcome to QEMU's documentation!
 ================================
 ================================
 
 

+ 1 - 0
docs/system/qemu-block-drivers.rst

@@ -1,5 +1,6 @@
 :orphan:
 :orphan:
 
 
+============================
 QEMU block drivers reference
 QEMU block drivers reference
 ============================
 ============================
 
 

+ 1 - 0
docs/system/qemu-cpu-models.rst

@@ -1,5 +1,6 @@
 :orphan:
 :orphan:
 
 
+==================================
 QEMU / KVM CPU model configuration
 QEMU / KVM CPU model configuration
 ==================================
 ==================================
 
 

+ 3 - 2
docs/system/qemu-manpage.rst

@@ -6,8 +6,9 @@
    parts of the documentation that go in the manpage as well as the
    parts of the documentation that go in the manpage as well as the
    HTML manual.
    HTML manual.
 
 
-Title
-=====
+=======================
+QEMU User Documentation
+=======================
 
 
 Synopsis
 Synopsis
 --------
 --------

+ 1 - 0
docs/tools/qemu-img.rst

@@ -1,3 +1,4 @@
+=======================
 QEMU disk image utility
 QEMU disk image utility
 =======================
 =======================
 
 

+ 1 - 0
docs/tools/qemu-nbd.rst

@@ -1,3 +1,4 @@
+=====================================
 QEMU Disk Network Block Device Server
 QEMU Disk Network Block Device Server
 =====================================
 =====================================
 
 

+ 1 - 0
docs/tools/qemu-pr-helper.rst

@@ -1,3 +1,4 @@
+==================================
 QEMU persistent reservation helper
 QEMU persistent reservation helper
 ==================================
 ==================================
 
 

+ 1 - 0
docs/tools/qemu-storage-daemon.rst

@@ -1,3 +1,4 @@
+===================
 QEMU Storage Daemon
 QEMU Storage Daemon
 ===================
 ===================
 
 

+ 1 - 0
docs/tools/qemu-trace-stap.rst

@@ -1,3 +1,4 @@
+=========================
 QEMU SystemTap trace tool
 QEMU SystemTap trace tool
 =========================
 =========================