[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v2 5/8] qemu-img: Convert invocation documentation to rST
From: |
Alex Bennée |
Subject: |
Re: [PATCH v2 5/8] qemu-img: Convert invocation documentation to rST |
Date: |
Fri, 31 Jan 2020 15:14:19 +0000 |
User-agent: |
mu4e 1.3.7; emacs 27.0.60 |
Peter Maydell <address@hidden> writes:
> 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 <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
--
Alex Bennée
- [PATCH v2 3/8] docs/sphinx: Add new hxtool Sphinx extension, (continued)
- [PATCH v2 3/8] docs/sphinx: Add new hxtool Sphinx extension, Peter Maydell, 2020/01/24
- [PATCH v2 4/8] qemu-img-cmds.hx: Add rST documentation fragments, Peter Maydell, 2020/01/24
- [PATCH v2 6/8] qemu-img-cmds.hx: Remove texinfo document fragments, Peter Maydell, 2020/01/24
- [PATCH v2 7/8] scripts/qemu-trace-stap: Convert documentation to rST, Peter Maydell, 2020/01/24
- [PATCH v2 8/8] virtfs-proxy-helper: Convert documentation to rST, Peter Maydell, 2020/01/24
- [PATCH v2 5/8] qemu-img: Convert invocation documentation to rST, Peter Maydell, 2020/01/24
- Re: [PATCH v2 5/8] qemu-img: Convert invocation documentation to rST,
Alex Bennée <=
- Re: [PATCH v2 0/8] qemu-img, qemu-trace-stap, virtfs-proxy-helper: convert to rST, Peter Maydell, 2020/01/31