[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 0/5] qemu-img: convert to rST

From: Peter Maydell
Subject: [PATCH 0/5] qemu-img: convert to rST
Date: Tue, 21 Jan 2020 19:10:28 +0000

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:

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.

-- PMM

Based-on: address@hidden
("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


reply via email to

[Prev in Thread] Current Thread [Next in Thread]