qapi: Doc generation fixes
Get series with b4
b4 am [email protected]Versions newest first
- v1 Latest19 patches 0 repliesNew
Patches in v1 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/19 | tests/qapi-schema: Demonstrate feature and enum doc comment bugstests/ tests/ tests/ +7 more | +89 | 0 replies | |
| 2/19 | tests/qapi-schema: Demonstrate command and event doc comment bugstests/ tests/ tests/ +7 more | +90 | 0 replies | |
| 3/19 | tests/qapi-schema: Cover alternate documentation commentstests/ tests/ tests/ | +37 | 0 replies | |
| 4/19 | tests/qapi-schema: Fix feature documentation testingtests/ tests/ tests/ +1 more | +16 | 0 replies | |
| 5/19 | qemu-doc: Belatedly document QMP command deprecationqemu-deprecated.texi | +12 | 0 replies | |
| 6/19 | qapi: Implement boxed event argument documentationscripts/ tests/ tests/ +1 more | +13 | 0 replies | |
| 7/19 | qapi: De-duplicate entity documentation generation codescripts/ | +40 | 0 replies | |
| 8/19 | qapi: Split .connect_doc(), .check_doc() off .check()scripts/ | +27 | 0 replies | |
| 9/19 | qapi: Fix enum doc comment checkingscripts/ tests/ tests/ +1 more | +5 | 0 replies | |
| 10/19 | qapi: Clean up doc comment checking for implicit union basescripts/ | +16 | 0 replies | |
| 11/19 | qapi: Fix doc comment checking for commands and eventsqapi/ scripts/ scripts/ +6 more | +25 | 0 replies | |
| 12/19 | qapi: Simplify ._make_implicit_object_type()scripts/ | +6 | 0 replies | |
| 13/19 | qapi: Eliminate .check_doc() overridesscripts/ | +2 | 0 replies | |
| 14/19 | qapi: Fold normalize_if() into check_if()scripts/ | +1 | 0 replies | |
| 15/19 | qapi: Fold normalize_features() into check_features()scripts/ | +2 | 0 replies | |
| 16/19 | qapi: Fold normalize_enum() into check_enum()scripts/ | +2 | 0 replies | |
| 17/19 | qapi: Lift features into QAPISchemaEntityscripts/ | +11 | 0 replies | |
| 18/19 | qapi: Polish reporting of bogus member documentationscripts/ tests/ tests/ +4 more | +10 | 0 replies | |
| 19/19 | qapi: Check feature documentation against the schemascripts/ scripts/ tests/ +5 more | +27 | 0 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.
Cover letter [PATCH 00/19] qapi: Doc generation fixes
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
Signature · 1 line
2.21.0