[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 00/19] qapi: Doc generation fixes
From: |
Markus Armbruster |
Subject: |
[PATCH 00/19] qapi: Doc generation fixes |
Date: |
Thu, 24 Oct 2019 13:02:18 +0200 |
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
- [PATCH 00/19] qapi: Doc generation fixes,
Markus Armbruster <=
- [PATCH 01/19] tests/qapi-schema: Demonstrate feature and enum doc comment bugs, Markus Armbruster, 2019/10/24
- [PATCH 13/19] qapi: Eliminate .check_doc() overrides, Markus Armbruster, 2019/10/24
- [PATCH 16/19] qapi: Fold normalize_enum() into check_enum(), Markus Armbruster, 2019/10/24
- [PATCH 12/19] qapi: Simplify ._make_implicit_object_type(), Markus Armbruster, 2019/10/24
- [PATCH 05/19] qemu-doc: Belatedly document QMP command deprecation, Markus Armbruster, 2019/10/24
- [PATCH 10/19] qapi: Clean up doc comment checking for implicit union base, Markus Armbruster, 2019/10/24
- [PATCH 08/19] qapi: Split .connect_doc(), .check_doc() off .check(), Markus Armbruster, 2019/10/24
- [PATCH 18/19] qapi: Polish reporting of bogus member documentation, Markus Armbruster, 2019/10/24
- [PATCH 04/19] tests/qapi-schema: Fix feature documentation testing, Markus Armbruster, 2019/10/24
- [PATCH 03/19] tests/qapi-schema: Cover alternate documentation comments, Markus Armbruster, 2019/10/24