From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: kwolf@redhat.com, pkrempa@redhat.com, mdroth@linux.vnet.ibm.com
Subject: [PATCH 00/19] qapi: Doc generation fixes
Date: Thu, 24 Oct 2019 13:02:18 +0200 [thread overview]
Message-ID: <20191024110237.30963-1-armbru@redhat.com> (raw)
The recent patches to introduce feature flags neglected doc
generation. While fixing that, I found similar neglect in non-recent
patches. Fix all that, and clean up some.
Markus Armbruster (19):
tests/qapi-schema: Demonstrate feature and enum doc comment bugs
tests/qapi-schema: Demonstrate command and event doc comment bugs
tests/qapi-schema: Cover alternate documentation comments
tests/qapi-schema: Fix feature documentation testing
qemu-doc: Belatedly document QMP command deprecation
qapi: Implement boxed event argument documentation
qapi: De-duplicate entity documentation generation code
qapi: Split .connect_doc(), .check_doc() off .check()
qapi: Fix enum doc comment checking
qapi: Clean up doc comment checking for implicit union base
qapi: Fix doc comment checking for commands and events
qapi: Simplify ._make_implicit_object_type()
qapi: Eliminate .check_doc() overrides
qapi: Fold normalize_if() into check_if()
qapi: Fold normalize_features() into check_features()
qapi: Fold normalize_enum() into check_enum()
qapi: Lift features into QAPISchemaEntity
qapi: Polish reporting of bogus member documentation
qapi: Check feature documentation against the schema
qemu-deprecated.texi | 12 +++
tests/qapi-schema/doc-good.texi | 27 ++++++
qapi/net.json | 2 -
scripts/qapi/doc.py | 75 +++++++-------
scripts/qapi/expr.py | 32 +-----
scripts/qapi/parser.py | 29 ++++--
scripts/qapi/schema.py | 97 +++++++++++--------
tests/Makefile.include | 5 +
.../qapi-schema/doc-bad-alternate-member.err | 2 +-
.../qapi-schema/doc-bad-boxed-command-arg.err | 1 +
.../doc-bad-boxed-command-arg.json | 14 +++
.../qapi-schema/doc-bad-boxed-command-arg.out | 0
tests/qapi-schema/doc-bad-command-arg.err | 2 +-
tests/qapi-schema/doc-bad-enum-member.err | 1 +
tests/qapi-schema/doc-bad-enum-member.json | 8 ++
tests/qapi-schema/doc-bad-enum-member.out | 0
tests/qapi-schema/doc-bad-event-arg.err | 1 +
tests/qapi-schema/doc-bad-event-arg.json | 7 ++
tests/qapi-schema/doc-bad-event-arg.out | 0
tests/qapi-schema/doc-bad-feature.err | 1 +
tests/qapi-schema/doc-bad-feature.json | 9 ++
tests/qapi-schema/doc-bad-feature.out | 0
tests/qapi-schema/doc-bad-union-member.err | 2 +-
tests/qapi-schema/doc-good.json | 14 +++
tests/qapi-schema/doc-good.out | 27 ++++++
tests/qapi-schema/doc-undoc-feature.err | 2 +
tests/qapi-schema/doc-undoc-feature.json | 9 ++
tests/qapi-schema/doc-undoc-feature.out | 0
tests/qapi-schema/test-qapi.py | 2 +
29 files changed, 270 insertions(+), 111 deletions(-)
create mode 100644 tests/qapi-schema/doc-bad-boxed-command-arg.err
create mode 100644 tests/qapi-schema/doc-bad-boxed-command-arg.json
create mode 100644 tests/qapi-schema/doc-bad-boxed-command-arg.out
create mode 100644 tests/qapi-schema/doc-bad-enum-member.err
create mode 100644 tests/qapi-schema/doc-bad-enum-member.json
create mode 100644 tests/qapi-schema/doc-bad-enum-member.out
create mode 100644 tests/qapi-schema/doc-bad-event-arg.err
create mode 100644 tests/qapi-schema/doc-bad-event-arg.json
create mode 100644 tests/qapi-schema/doc-bad-event-arg.out
create mode 100644 tests/qapi-schema/doc-bad-feature.err
create mode 100644 tests/qapi-schema/doc-bad-feature.json
create mode 100644 tests/qapi-schema/doc-bad-feature.out
create mode 100644 tests/qapi-schema/doc-undoc-feature.err
create mode 100644 tests/qapi-schema/doc-undoc-feature.json
create mode 100644 tests/qapi-schema/doc-undoc-feature.out
--
2.21.0
next reply other threads:[~2019-10-24 11:09 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-24 11:02 Markus Armbruster [this message]
2019-10-24 11:02 ` [PATCH 01/19] tests/qapi-schema: Demonstrate feature and enum doc comment bugs Markus Armbruster
2019-10-24 11:02 ` [PATCH 02/19] tests/qapi-schema: Demonstrate command and event " Markus Armbruster
2019-10-24 11:02 ` [PATCH 03/19] tests/qapi-schema: Cover alternate documentation comments Markus Armbruster
2019-10-24 11:02 ` [PATCH 04/19] tests/qapi-schema: Fix feature documentation testing Markus Armbruster
2019-10-24 11:02 ` [PATCH 05/19] qemu-doc: Belatedly document QMP command deprecation Markus Armbruster
2019-10-24 11:02 ` [PATCH 06/19] qapi: Implement boxed event argument documentation Markus Armbruster
2019-10-24 11:02 ` [PATCH 07/19] qapi: De-duplicate entity documentation generation code Markus Armbruster
2019-10-24 11:02 ` [PATCH 08/19] qapi: Split .connect_doc(), .check_doc() off .check() Markus Armbruster
2019-10-24 11:02 ` [PATCH 09/19] qapi: Fix enum doc comment checking Markus Armbruster
2019-10-24 11:02 ` [PATCH 10/19] qapi: Clean up doc comment checking for implicit union base Markus Armbruster
2019-10-24 11:02 ` [PATCH 11/19] qapi: Fix doc comment checking for commands and events Markus Armbruster
2019-10-24 11:02 ` [PATCH 12/19] qapi: Simplify ._make_implicit_object_type() Markus Armbruster
2019-10-24 11:02 ` [PATCH 13/19] qapi: Eliminate .check_doc() overrides Markus Armbruster
2019-10-24 11:02 ` [PATCH 14/19] qapi: Fold normalize_if() into check_if() Markus Armbruster
2019-10-24 11:02 ` [PATCH 15/19] qapi: Fold normalize_features() into check_features() Markus Armbruster
2019-10-24 11:02 ` [PATCH 16/19] qapi: Fold normalize_enum() into check_enum() Markus Armbruster
2019-10-24 11:02 ` [PATCH 17/19] qapi: Lift features into QAPISchemaEntity Markus Armbruster
2019-10-24 11:02 ` [PATCH 18/19] qapi: Polish reporting of bogus member documentation Markus Armbruster
2019-10-24 11:02 ` [PATCH 19/19] qapi: Check feature documentation against the schema 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=20191024110237.30963-1-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=kwolf@redhat.com \
--cc=mdroth@linux.vnet.ibm.com \
--cc=pkrempa@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).