[libvirt PATCH 5/6] virt-qemu-run: Improve manual page

[Andrea Bolognani]

On Fri, Dec 10, 2021 at 06:16:06PM +0100, Ján Tomko wrote:
> On a Friday in 2021, Andrea Bolognani wrote:
> > -``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.

So it does! Great catch, I don't know how I failed to notice.

> Prefixing both lines with '|' fixed that for me:
>
> -``virt-qemu-run`` [*OPTIONS...*] *GUEST-XML-FILE*
> -``virt-qemu-run`` *OPTION*
> +| ``virt-qemu-run`` [*OPTIONS...*] *GUEST-XML-FILE*
> +| ``virt-qemu-run`` *OPTION*

I ended up adopting a slightly different approach: since the only
situations in which you would not pass some mandatory ARGUMENT to the
commands is for '--version' and '--help', which are extremely
widespread and well understood, I've just changed the usage to

  ``command`` [*OPTION*]... *ARGUMENT*

in all manual pages. I think this is a good solution, but if you'd
rather see the version with two separate lines just let me know and I
will prepare a follow-up patch.

Thank you for the review! :)

-- 
Andrea Bolognani / Red Hat / Virtualization