]> git.proxmox.com Git - mirror_qemu.git/commit
qemu-option-trace.rst.inc: Don't use option:: markup
authorPeter Maydell <peter.maydell@linaro.org>
Mon, 2 Nov 2020 16:52:18 +0000 (16:52 +0000)
committerPeter Maydell <peter.maydell@linaro.org>
Mon, 2 Nov 2020 16:52:18 +0000 (16:52 +0000)
commit5a4b0d411283c92c5a394aaa4b7c19f6568a54fd
tree0480807ad7c575c44ed29cf37f4cc13289ea4f39
parent92bb29f9b2c3d4a98eef5f0db935d4be291eec72
qemu-option-trace.rst.inc: Don't use option:: markup

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>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Tested-by: Stefan Hajnoczi <stefanha@redhat.com>
Message-id: 20201030174700.7204-3-peter.maydell@linaro.org
docs/qemu-option-trace.rst.inc