[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 11/21] docs/system: standardize man page sections to --- with over
From: |
Paolo Bonzini |
Subject: |
[PULL 11/21] docs/system: standardize man page sections to --- with overline |
Date: |
Mon, 13 Sep 2021 13:57:32 +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 | 3 +++
docs/system/qemu-cpu-models.rst | 9 ++++++---
docs/system/qemu-manpage.rst | 5 +++++
3 files changed, 14 insertions(+), 3 deletions(-)
diff --git a/docs/system/qemu-block-drivers.rst
b/docs/system/qemu-block-drivers.rst
index eb276481d6..c2c0114cec 100644
--- a/docs/system/qemu-block-drivers.rst
+++ b/docs/system/qemu-block-drivers.rst
@@ -4,16 +4,19 @@
QEMU block drivers reference
============================
+--------
Synopsis
--------
QEMU block driver reference manual
+-----------
Description
-----------
.. include:: qemu-block-drivers.rst.inc
+--------
See also
--------
diff --git a/docs/system/qemu-cpu-models.rst b/docs/system/qemu-cpu-models.rst
index 8c51e2bf49..5cf6e46f8a 100644
--- a/docs/system/qemu-cpu-models.rst
+++ b/docs/system/qemu-cpu-models.rst
@@ -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.
diff --git a/docs/system/qemu-manpage.rst b/docs/system/qemu-manpage.rst
index d6f44e265b..c47a412758 100644
--- a/docs/system/qemu-manpage.rst
+++ b/docs/system/qemu-manpage.rst
@@ -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
--------
--
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 <=
- [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, 2021/09/13
- [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