haraldwolff/qemu-patch-raspberry4
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

docs/system: standardize man page sections to --- with overline

Browse source 
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>
This commit is contained in:
Paolo Bonzini 2021-09-07 17:33:27 +02:00
parent 06905f6402
commit f0c1507a2b
3 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/system/qemu-block-drivers.rst
View file

@ -4,16 +4,19 @@
QEMU block drivers reference
============================
--------
Synopsis
--------
QEMU block driver reference manual
-----------
Description
-----------
.. include:: qemu-block-drivers.rst.inc
--------
See also
--------

9
docs/system/qemu-cpu-models.rst
View 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.

5
docs/system/qemu-manpage.rst
View 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
--------