diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2020-01-24 16:26:03 +0000 |
|---|---|---|
| committer | Peter Maydell <peter.maydell@linaro.org> | 2020-02-03 11:02:22 +0000 |
| commit | e13c59fa4414215500e66c2604292caa6e80d57e (patch) | |
| tree | 1af77095a32d47bfd596de8648a648ace2897a20 /qemu-doc.texi | |
| parent | 195b51094cd95247b75248414e6aee38cf6fb0f6 (diff) | |
| download | qemu-e13c59fa4414215500e66c2604292caa6e80d57e.zip qemu-e13c59fa4414215500e66c2604292caa6e80d57e.tar.gz qemu-e13c59fa4414215500e66c2604292caa6e80d57e.tar.bz2 | |
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
Diffstat (limited to 'qemu-doc.texi')
| -rw-r--r-- | qemu-doc.texi | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/qemu-doc.texi b/qemu-doc.texi index b79f1c3..a1ef6b6 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -632,7 +632,6 @@ encrypted disk images. * disk_images_quickstart:: Quick start for disk image creation * disk_images_snapshot_mode:: Snapshot mode * vm_snapshots:: VM snapshots -* qemu_img_invocation:: qemu-img Invocation @end menu @node disk_images_quickstart @@ -646,7 +645,9 @@ where @var{myimage.img} is the disk image filename and @var{mysize} is its size in kilobytes. You can add an @code{M} suffix to give the size in megabytes and a @code{G} suffix for gigabytes. -See @ref{qemu_img_invocation} for more information. +@c When this document is converted to rst we should make this into +@c a proper linked reference to the qemu-img documentation again: +See the qemu-img invocation documentation for more information. @node disk_images_snapshot_mode @subsection Snapshot mode @@ -708,11 +709,6 @@ A few device drivers still have incomplete snapshot support so their state is not saved or restored properly (in particular USB). @end itemize -@node qemu_img_invocation -@subsection @code{qemu-img} Invocation - -@include qemu-img.texi - @node pcsys_network @section Network emulation |