From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Cc: Kevin Wolf <kwolf@redhat.com>,
qemu-block@nongnu.org, Markus Armbruster <armbru@redhat.com>,
Max Reitz <mreitz@redhat.com>,
Stefan Hajnoczi <stefanha@redhat.com>,
John Snow <jsnow@redhat.com>
Subject: [PATCH 0/5] qemu-img: convert to rST
Date: Tue, 21 Jan 2020 19:10:28 +0000 [thread overview]
Message-ID: <20200121191033.28195-1-peter.maydell@linaro.org> (raw)
This patchset converts the qemu-img documentation to rST format.
It includes a new Sphinx extension which handles parsing the .hx
files which provide documentation fragments for this manual.
The general approach follows the outline in the email I
sent the other day:
https://lists.gnu.org/archive/html/qemu-devel/2020-01/msg03786.html
The new Sphinx extension implements the hxtool-doc::
directive, which indicates where the assembled rST
document fragments should be inserted into the manual.
qemu-img-cmds.hx doesn't use the DEFHEADING or ARCHHEADING
directives, but the extension implements them (tested
with some local modifications to the .hx file to check
that they do the right thing).
As noted in the commit message for the qemu-img.texi conversion,
I have not attempted to tackle any of the muddle in the
current documentation structure or the repetition between
the manual document, the fragments in the .hx file and
the C code; this is a "simplest thing that works"
like-for-like conversion.
Another deliberate omission is that I have not attempted
to get links between our various Sphinx manuals (system,
interop, etc) working yet, as this is not totally trivial
and the odd minor missed hyperlink doesn't seem to me
to be a deal-breaker.
Sorry about the size of the main 'convert qemu-img'
patch, but it's unavoidable when converting a big
document between formats.
thanks
-- PMM
Based-on: 20200116141511.16849-1-peter.maydell@linaro.org
("convert qemu-nbd, qemu-block-drivers to rST";
dependencies are mostly textual and in a few bits of
the makefile machinery)
Peter Maydell (5):
hxtool: Support SRST/ERST directives
docs/sphinx: Add new hxtool Sphinx extension
qemu-img-cmds.hx: Add rST documentation fragments
qemu-img: Convert invocation documentation to rST
qemu-img-cmds.hx: Remove texinfo document fragments
Makefile | 19 +-
MAINTAINERS | 1 +
docs/conf.py | 3 +-
docs/interop/conf.py | 2 +
docs/interop/index.rst | 1 +
docs/interop/qemu-img.rst | 822 ++++++++++++++++++++++++++++++++++++++
docs/sphinx/hxtool.py | 210 ++++++++++
qemu-doc.texi | 10 +-
qemu-img-cmds.hx | 99 +++--
qemu-img.texi | 795 ------------------------------------
scripts/hxtool | 33 +-
11 files changed, 1128 insertions(+), 867 deletions(-)
create mode 100644 docs/interop/qemu-img.rst
create mode 100644 docs/sphinx/hxtool.py
delete mode 100644 qemu-img.texi
--
2.20.1
next reply other threads:[~2020-01-21 19:12 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-21 19:10 Peter Maydell [this message]
2020-01-21 19:10 ` [PATCH 1/5] hxtool: Support SRST/ERST directives Peter Maydell
2020-01-21 20:33 ` Richard Henderson
2020-01-21 19:10 ` [PATCH 2/5] docs/sphinx: Add new hxtool Sphinx extension Peter Maydell
2020-01-21 21:53 ` Richard Henderson
2020-01-21 22:22 ` Peter Maydell
2020-01-22 0:15 ` Richard Henderson
2020-01-23 17:33 ` Peter Maydell
2020-01-21 19:10 ` [PATCH 3/5] qemu-img-cmds.hx: Add rST documentation fragments Peter Maydell
2020-01-21 21:55 ` Richard Henderson
2020-01-21 19:10 ` [PATCH 4/5] qemu-img: Convert invocation documentation to rST Peter Maydell
2020-01-21 19:10 ` [PATCH 5/5] qemu-img-cmds.hx: Remove texinfo document fragments Peter Maydell
2020-01-21 21:55 ` Richard Henderson
2020-01-21 20:16 ` [PATCH 0/5] qemu-img: convert to rST no-reply
2020-01-21 20:55 ` no-reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200121191033.28195-1-peter.maydell@linaro.org \
--to=peter.maydell@linaro.org \
--cc=armbru@redhat.com \
--cc=jsnow@redhat.com \
--cc=kwolf@redhat.com \
--cc=mreitz@redhat.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).