]> www.infradead.org Git - users/dwmw2/qemu.git/commitdiff
docs/system: standardize man page sections to --- with overline
authorPaolo Bonzini <pbonzini@redhat.com>
Tue, 7 Sep 2021 15:33:27 +0000 (17:33 +0200)
committerPaolo Bonzini <pbonzini@redhat.com>
Mon, 13 Sep 2021 11:56:26 +0000 (13:56 +0200)
Man pages in docs/system use file inclusion heavily.  Use headings with
overlines in the main files, so that the same included file work well
from both manuals and man pages.

This style of heading is a bit more heavy-weight, so it is not used by
the other man pages in interop/ and tools/.  If in the future they
are changed to use include files, for example to avoid having sections
named "synopsis" or "description", they can switch to --- with overline
as well.

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
docs/system/qemu-block-drivers.rst
docs/system/qemu-cpu-models.rst
docs/system/qemu-manpage.rst

index eb276481d61c18de26df02c938f595a6a05c0f83..c2c0114cec4af0c6b451cbcbf1f3504765c38be0 100644 (file)
@@ -4,16 +4,19 @@
 QEMU block drivers reference
 ============================
 
+--------
 Synopsis
 --------
 
 QEMU block driver reference manual
 
+-----------
 Description
 -----------
 
 .. include:: qemu-block-drivers.rst.inc
 
+--------
 See also
 --------
 
index 8c51e2bf49a8d02610e4bd1ec85d55574c747aff..5cf6e46f8ae1e6cf88765a4bb707a6d89f2ab87b 100644 (file)
@@ -4,18 +4,21 @@
 QEMU / KVM CPU model configuration
 ==================================
 
+--------
 Synopsis
-''''''''
+--------
 
 QEMU CPU Modelling Infrastructure manual
 
+-----------
 Description
-'''''''''''
+-----------
 
 .. include:: cpu-models-x86.rst.inc
 .. include:: cpu-models-mips.rst.inc
 
+--------
 See also
-''''''''
+--------
 
 The HTML documentation of QEMU for more precise information and Linux user mode emulator invocation.
index d6f44e265bec04a722394f0b9bbf5610ea0ba3d4..c47a4127582f2946664f3e2cdbef77846b87c1db 100644 (file)
@@ -10,6 +10,7 @@
 QEMU User Documentation
 =======================
 
+--------
 Synopsis
 --------
 
@@ -17,11 +18,13 @@ Synopsis
 
    |qemu_system| [options] [disk_image]
 
+-----------
 Description
 -----------
 
 .. include:: target-i386-desc.rst.inc
 
+-------
 Options
 -------
 
@@ -34,11 +37,13 @@ not need a disk image.
 
 .. include:: mux-chardev.rst.inc
 
+-----
 Notes
 -----
 
 .. include:: device-url-syntax.rst.inc
 
+--------
 See also
 --------