On a Friday in 2021, Andrea Bolognani wrote:
Specifically: * use the correct notation and markup for commands, options and arguments; * rename arguments meta-variables; * document '--help' and '--version' options; * use consistent vertical spacing; * fix a typo. Signed-off-by: Andrea Bolognani <abologna@xxxxxxxxxx> --- docs/manpages/virt-qemu-run.rst | 53 +++++++++++++++++++-------------- 1 file changed, 31 insertions(+), 22 deletions(-) diff --git a/docs/manpages/virt-qemu-run.rst b/docs/manpages/virt-qemu-run.rst index 470de93168..a755b7fda9 100644 --- a/docs/manpages/virt-qemu-run.rst +++ b/docs/manpages/virt-qemu-run.rst @@ -11,10 +11,13 @@ Run a standalone QEMU guest .. contents:: + SYNOPSIS ======== -``virt-qemu-run [OPTIONS...] [GUEST-XML]`` +``virt-qemu-run`` [*OPTIONS...*] *GUEST-XML-FILE* +``virt-qemu-run`` *OPTION* +
This puts them both on the same line in the resulting man page. Prefixing both lines with '|' fixed that for me: diff --git a/docs/manpages/virt-qemu-run.rst b/docs/manpages/virt-qemu-run.rst index a755b7fda9..1bc1a7f6f7 100644 --- a/docs/manpages/virt-qemu-run.rst +++ b/docs/manpages/virt-qemu-run.rst @@ -15,8 +15,8 @@ Run a standalone QEMU guest SYNOPSIS ======== -``virt-qemu-run`` [*OPTIONS...*] *GUEST-XML-FILE* -``virt-qemu-run`` *OPTION* +| ``virt-qemu-run`` [*OPTIONS...*] *GUEST-XML-FILE* +| ``virt-qemu-run`` *OPTION* DESCRIPTION Reviewed-by: Ján Tomko <jtomko@xxxxxxxxxx> Jano
Attachment:
signature.asc
Description: PGP signature
