[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL v4 39/43] docs/system: standardize man page sections to --- with o
From: |
Paolo Bonzini |
Subject: |
[PULL v4 39/43] docs/system: standardize man page sections to --- with overline |
Date: |
Wed, 8 Sep 2021 12:04:22 +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 v4 21/43] i386: Update SGX CPUID info according to hardware/KVM/user input, (continued)
- [PULL v4 21/43] i386: Update SGX CPUID info according to hardware/KVM/user input, Paolo Bonzini, 2021/09/08
- [PULL v4 22/43] i386: kvm: Add support for exposing PROVISIONKEY to guest, Paolo Bonzini, 2021/09/08
- [PULL v4 19/43] fw_cfg: add etc/msr_feature_control, Paolo Bonzini, 2021/09/08
- [PULL v4 27/43] i386/pc: Add e820 entry for SGX EPC section(s), Paolo Bonzini, 2021/09/08
- [PULL v4 32/43] sgx-epc: Add the reset interface for sgx-epc virt device, Paolo Bonzini, 2021/09/08
- [PULL v4 15/43] i386: Add SGX CPUID leaf FEAT_SGX_12_0_EAX, Paolo Bonzini, 2021/09/08
- [PULL v4 36/43] sgx-epc: Add the fill_device_info() callback support, Paolo Bonzini, 2021/09/08
- [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 <=
- [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, 2021/09/08
- [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