From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Cédric Le Goater" <clg@redhat.com>,
"Kevin Wolf" <kwolf@redhat.com>,
"Fabiano Rosas" <farosas@suse.de>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Peter Xu" <peterx@redhat.com>,
"Jason Wang" <jasowang@redhat.com>,
"Igor Mammedov" <imammedo@redhat.com>,
qemu-block@nongnu.org, "Lukas Straub" <lukasstraub2@web.de>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Eric Blake" <eblake@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Jiri Pirko" <jiri@resnulli.us>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Mads Ynddal" <mads@ynddal.dk>,
"Stefan Berger" <stefanb@linux.vnet.ibm.com>,
"Pavel Dovgalyuk" <pavel.dovgaluk@ispras.ru>,
"Michael Roth" <michael.roth@amd.com>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Alex Williamson" <alex.williamson@redhat.com>,
"Yanan Wang" <wangyanan55@huawei.com>,
"Eduardo Habkost" <eduardo@habkost.net>,
"Ani Sinha" <anisinha@redhat.com>,
"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Hanna Reitz" <hreitz@redhat.com>, "John Snow" <jsnow@redhat.com>
Subject: [PATCH v2 0/9] qapi: convert example sections to qmp-example rST directives
Date: Tue, 16 Jul 2024 22:13:02 -0400 [thread overview]
Message-ID: <20240717021312.606116-1-jsnow@redhat.com> (raw)
This patchset focuses on converting example sections to rST directives
using a new `.. qmp-example::` directive.
V2:
- Rebased on origin/master; converted one more example
- Fixed (most?) minor nits from last review
- Didn't address lack of newline in text mode or enhanced lexer (yet)
Changes since this was split out from the prior series:
- Harmonie updated the CSS for the example block section.
I think it's really tidy now! Thanks Harmonie!
- Dependence on SphinxDirective was removed, but it will likely
re-appear in the next series anyway.
- qapi-code-gen.rst was updated with a section on how to write examples.
- Various minor tweaks to comments, commit messages, docs, etc.
Harmonie Snow (1):
docs/sphinx: add CSS styling for qmp-example directive
John Snow (8):
[DO-NOT-MERGE]: Add some ad-hoc linting helpers.
docs/qapidoc: factor out do_parse()
docs/qapidoc: create qmp-example directive
docs/qapidoc: add QMP highlighting to annotated qmp-example blocks
qapi: convert "Example" sections without titles
qapi: convert "Example" sections with titles
qapi: convert "Example" sections with longer prose
qapi: remove "Example" doc section
docs/devel/qapi-code-gen.rst | 58 +++++++++--
docs/sphinx-static/theme_overrides.css | 49 ++++++++++
docs/sphinx/qapidoc.py | 130 ++++++++++++++++++++++---
qapi/acpi.json | 4 +-
qapi/block-core.json | 88 +++++++++--------
qapi/block.json | 57 ++++++-----
qapi/char.json | 24 +++--
qapi/control.json | 8 +-
qapi/dump.json | 8 +-
qapi/machine-target.json | 2 +-
qapi/machine.json | 68 +++++++------
qapi/migration.json | 90 +++++++++--------
qapi/misc-target.json | 22 ++---
qapi/misc.json | 32 +++---
qapi/net.json | 22 +++--
qapi/pci.json | 2 +-
qapi/qdev.json | 10 +-
qapi/qom.json | 16 +--
qapi/replay.json | 8 +-
qapi/rocker.json | 8 +-
qapi/run-state.json | 32 +++---
qapi/tpm.json | 6 +-
qapi/trace.json | 4 +-
qapi/transaction.json | 2 +-
qapi/ui.json | 45 ++++-----
qapi/vfio.json | 2 +-
qapi/virtio.json | 45 ++++++---
qapi/yank.json | 4 +-
scripts/qapi-lint.sh | 61 ++++++++++++
scripts/qapi/Makefile | 5 +
scripts/qapi/parser.py | 10 +-
tests/qapi-schema/doc-good.json | 19 ++--
tests/qapi-schema/doc-good.out | 26 +++--
tests/qapi-schema/doc-good.txt | 23 ++---
34 files changed, 662 insertions(+), 328 deletions(-)
create mode 100755 scripts/qapi-lint.sh
create mode 100644 scripts/qapi/Makefile
--
2.45.0
next reply other threads:[~2024-07-17 2:14 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-17 2:13 John Snow [this message]
2024-07-17 2:13 ` [PATCH v2 1/9] [DO-NOT-MERGE]: Add some ad-hoc linting helpers John Snow
2024-07-17 2:13 ` [PATCH v2 2/9] docs/qapidoc: factor out do_parse() John Snow
2024-07-17 2:13 ` [PATCH v2 3/9] docs/qapidoc: create qmp-example directive John Snow
2024-07-17 2:13 ` [PATCH v2 4/9] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks John Snow
2024-07-17 2:13 ` [PATCH v2 5/9] docs/sphinx: add CSS styling for qmp-example directive John Snow
2024-07-17 2:13 ` [PATCH v2 6/9] qapi: convert "Example" sections without titles John Snow
2024-07-17 7:43 ` Markus Armbruster
2024-07-17 20:15 ` John Snow
2024-07-18 4:21 ` Markus Armbruster
2024-07-17 2:13 ` [PATCH v2 7/9] qapi: convert "Example" sections with titles John Snow
2024-07-17 2:13 ` [PATCH v2 8/9] qapi: convert "Example" sections with longer prose John Snow
2024-07-17 2:13 ` [PATCH v2 9/9] qapi: remove "Example" doc section John Snow
2024-07-17 7:48 ` Markus Armbruster
2024-07-17 10:47 ` [PATCH v2 0/9] qapi: convert example sections to qmp-example rST directives Markus Armbruster
2024-07-17 20:13 ` John Snow
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=20240717021312.606116-1-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.williamson@redhat.com \
--cc=anisinha@redhat.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=clg@redhat.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=farosas@suse.de \
--cc=hreitz@redhat.com \
--cc=imammedo@redhat.com \
--cc=jasowang@redhat.com \
--cc=jiri@resnulli.us \
--cc=kwolf@redhat.com \
--cc=lukasstraub2@web.de \
--cc=mads@ynddal.dk \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=michael.roth@amd.com \
--cc=mst@redhat.com \
--cc=pavel.dovgaluk@ispras.ru \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=peterx@redhat.com \
--cc=philmd@linaro.org \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=stefanb@linux.vnet.ibm.com \
--cc=stefanha@redhat.com \
--cc=wangyanan55@huawei.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).