]> git.ipfire.org Git - thirdparty/qemu.git/commit
qemu-img: Convert invocation documentation to rST
authorPeter Maydell <peter.maydell@linaro.org>
Fri, 24 Jan 2020 16:26:03 +0000 (16:26 +0000)
committerPeter Maydell <peter.maydell@linaro.org>
Mon, 3 Feb 2020 11:02:22 +0000 (11:02 +0000)
commite13c59fa4414215500e66c2604292caa6e80d57e
tree1af77095a32d47bfd596de8648a648ace2897a20
parent195b51094cd95247b75248414e6aee38cf6fb0f6
qemu-img: Convert invocation documentation to rST

The qemu-img documentation is currently in qemu-nbd.texi in Texinfo
format, which we present to the user as:
 * a qemu-img manpage
 * a section of the main qemu-doc HTML documentation

Convert the documentation to rST format, and present it to the user as:
 * a qemu-img manpage
 * part of the interop/ Sphinx manual

The qemu-img rST document uses the new hxtool extension
to handle pulling rST fragments out of qemu-img-cmds.hx.

The documentation of the various options and commands is rather
muddled, with some options being described inside the relevant
command description and some in a more general section near the start
of the manual.  All the command synopses are replicated in the .hx
file and then again in the manual.  A lot of text is also duplicated
in the qemu-img.c code for the help text.  I have not attempted to
deal with any of this, but have simply transposed the existing
structure into rST.

As usual, there are some minor formatting changes but no
textual changes, except that as with one or two other conversions
I have dropped the 'see also' section since it's not very
informative and looks odd in the HTML.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Tested-by: Alex Bennée <alex.bennee@linaro.org>
Message-id: 20200124162606.8787-6-peter.maydell@linaro.org
MAINTAINERS
Makefile
docs/interop/conf.py
docs/interop/index.rst
docs/interop/qemu-img.rst [new file with mode: 0644]
qemu-doc.texi
qemu-img.texi [deleted file]