mbox series

[v3,0/3] docs/interop: Convert QMP related txt docs to rst

Message ID 20230515162245.3964307-1-peter.maydell@linaro.org
Headers show
Series docs/interop: Convert QMP related txt docs to rst | expand

Message

Peter Maydell May 15, 2023, 4:22 p.m. UTC 
This patchset deals with a couple of the old .txt files
that are still hanging around in docs/interop: qmp-spec.txt
and qmp-intro.txt. Patch 1 converts qmp-spec to rST and
integrates it into the manual. Patch 2 takes the only
interesting parts of qmp-intro.txt (the example command
lines) and puts those into qemu-options.hx so we can
delete the old .txt file.

v1->v2 changes:
 * some trivial tweaks suggested by Eric
 * all patches have been reviewed
v2->v3 changes:
 * patch 1: fix up references elsewhere to qmp-spec.txt
 * patch 2: new: updates an error description text

Still needing review:
 * patch 2
 * bits of patch 1 which update the qmp-spec.txt refs,
   though I felt they were minor enough that I retained
   Eric's Reviewed-by: tag

thanks
-- PMM


Peter Maydell (3):
  docs/interop: Convert qmp-spec.txt to rST
  docs/interop/qmp-spec: Update error description for parsing errors
  docs/interop: Delete qmp-intro.txt

 docs/devel/qapi-code-gen.rst                |   3 +-
 docs/interop/index.rst                      |   1 +
 docs/interop/qmp-intro.txt                  |  88 -----
 docs/interop/{qmp-spec.txt => qmp-spec.rst} | 337 +++++++++++---------
 qapi/control.json                           |   4 +-
 qapi/qapi-schema.json                       |   3 +-
 qobject/json-lexer.c                        |   2 +-
 python/qemu/qmp/models.py                   |   8 +-
 python/qemu/qmp/qmp_client.py               |   4 +-
 qemu-options.hx                             |  28 +-
 10 files changed, 221 insertions(+), 257 deletions(-)
 delete mode 100644 docs/interop/qmp-intro.txt
 rename docs/interop/{qmp-spec.txt => qmp-spec.rst} (55%)

Comments

Markus Armbruster May 16, 2023, 6:49 a.m. UTC | #1 
Peter Maydell <peter.maydell@linaro.org> writes:

> This patchset deals with a couple of the old .txt files
> that are still hanging around in docs/interop: qmp-spec.txt
> and qmp-intro.txt. Patch 1 converts qmp-spec to rST and
> integrates it into the manual. Patch 2 takes the only
> interesting parts of qmp-intro.txt (the example command
> lines) and puts those into qemu-options.hx so we can
> delete the old .txt file.

Queued.  Thanks!