Skip to content

Commit f0c1507

Browse files
committed
docs/system: standardize man page sections to --- with overline
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 <[email protected]> Signed-off-by: Paolo Bonzini <[email protected]>
1 parent 06905f6 commit f0c1507

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

docs/system/qemu-block-drivers.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,19 @@
44
QEMU block drivers reference
55
============================
66

7+
--------
78
Synopsis
89
--------
910

1011
QEMU block driver reference manual
1112

13+
-----------
1214
Description
1315
-----------
1416

1517
.. include:: qemu-block-drivers.rst.inc
1618

19+
--------
1720
See also
1821
--------
1922

docs/system/qemu-cpu-models.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,21 @@
44
QEMU / KVM CPU model configuration
55
==================================
66

7+
--------
78
Synopsis
8-
''''''''
9+
--------
910

1011
QEMU CPU Modelling Infrastructure manual
1112

13+
-----------
1214
Description
13-
'''''''''''
15+
-----------
1416

1517
.. include:: cpu-models-x86.rst.inc
1618
.. include:: cpu-models-mips.rst.inc
1719

20+
--------
1821
See also
19-
''''''''
22+
--------
2023

2124
The HTML documentation of QEMU for more precise information and Linux user mode emulator invocation.

docs/system/qemu-manpage.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,21 @@
1010
QEMU User Documentation
1111
=======================
1212

13+
--------
1314
Synopsis
1415
--------
1516

1617
.. parsed-literal::
1718
1819
|qemu_system| [options] [disk_image]
1920
21+
-----------
2022
Description
2123
-----------
2224

2325
.. include:: target-i386-desc.rst.inc
2426

27+
-------
2528
Options
2629
-------
2730

@@ -34,11 +37,13 @@ not need a disk image.
3437

3538
.. include:: mux-chardev.rst.inc
3639

40+
-----
3741
Notes
3842
-----
3943

4044
.. include:: device-url-syntax.rst.inc
4145

46+
--------
4247
See also
4348
--------
4449

0 commit comments

Comments
 (0)