qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Cc: Markus Armbruster <armbru@redhat.com>, Eric Blake <eblake@redhat.com>
Subject: [PATCH v3 0/3] docs/interop: Convert QMP related txt docs to rst
Date: Mon, 15 May 2023 17:22:42 +0100	[thread overview]
Message-ID: <20230515162245.3964307-1-peter.maydell@linaro.org> (raw)

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%)

-- 
2.34.1



             reply	other threads:[~2023-05-15 16:23 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-15 16:22 Peter Maydell [this message]
2023-05-15 16:22 ` [PATCH v3 1/3] docs/interop: Convert qmp-spec.txt to rST Peter Maydell
2023-05-16  6:18   ` Markus Armbruster
2023-05-15 16:22 ` [PATCH v3 2/3] docs/interop/qmp-spec: Update error description for parsing errors Peter Maydell
2023-05-15 21:10   ` Eric Blake
2023-05-16  6:19   ` Markus Armbruster
2023-05-15 16:22 ` [PATCH v3 3/3] docs/interop: Delete qmp-intro.txt Peter Maydell
2023-05-16  6:49 ` [PATCH v3 0/3] docs/interop: Convert QMP related txt docs to rst Markus Armbruster

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=20230515162245.3964307-1-peter.maydell@linaro.org \
    --to=peter.maydell@linaro.org \
    --cc=armbru@redhat.com \
    --cc=eblake@redhat.com \
    --cc=qemu-devel@nongnu.org \
    /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).