[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 2/2] qemu-option-trace.rst.inc: Don't use option:: markup
From: |
Daniel P . Berrangé |
Subject: |
Re: [PATCH 2/2] qemu-option-trace.rst.inc: Don't use option:: markup |
Date: |
Fri, 30 Oct 2020 17:48:43 +0000 |
User-agent: |
Mutt/1.14.6 (2020-07-11) |
On Fri, Oct 30, 2020 at 05:47:00PM +0000, Peter Maydell wrote:
> Sphinx 3.2 is pickier than earlier versions about the option:: markup,
> and complains about our usage in qemu-option-trace.rst:
>
> ../../docs/qemu-option-trace.rst.inc:4:Malformed option description
> '[enable=]PATTERN', should look like "opt", "-opt args", "--opt args",
> "/opt args" or "+opt args"
>
> In this file, we're really trying to document the different parts of
> the top-level --trace option, which qemu-nbd.rst and qemu-img.rst
> have already introduced with an option:: markup. So it's not right
> to use option:: here anyway. Switch to a different markup
> (definition lists) which gives about the same formatted output.
>
> (Unlike option::, this markup doesn't produce index entries; but
> at the moment we don't do anything much with indexes anyway, and
> in any case I think it doesn't make much sense to have individual
> index entries for the sub-parts of the --trace option.)
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> docs/qemu-option-trace.rst.inc | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|