From: Paolo Bonzini <pbonzini@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org
Subject: [PATCH 3/5] docs/system: standardize docs/system man page sections to --- with overline
Date: Tue, 7 Sep 2021 17:56:39 +0200 [thread overview]
Message-ID: <20210907155641.197844-4-pbonzini@redhat.com> (raw)
In-Reply-To: <20210907155641.197844-1-pbonzini@redhat.com>
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.
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
next prev parent reply other threads:[~2021-09-07 15:58 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-07 15:56 [PATCH 0/5] docs: reorganize target-i386 to make room for SGX Paolo Bonzini
2021-09-07 15:56 ` [PATCH 1/5] docs: standardize book titles to === with overline Paolo Bonzini
2021-09-07 16:08 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 2/5] docs: standardize directory index to --- " Paolo Bonzini
2021-09-07 16:08 ` Peter Maydell
2021-09-07 15:56 ` Paolo Bonzini [this message]
2021-09-07 16:21 ` [PATCH 3/5] docs/system: standardize docs/system man page sections " Peter Maydell
2021-09-07 15:56 ` [PATCH 4/5] docs/system: move x86 CPU configuration to a separate document Paolo Bonzini
2021-09-07 16:23 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 5/5] docs/system: move SGX documentation within the system docs Paolo Bonzini
2021-09-07 16:28 ` Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210907155641.197844-4-pbonzini@redhat.com \
--to=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).