Skip to content

qapi: Doc generation fixes

Markus Armbruster qemu-devel 1 version New

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest19 patches 0 repliesNew

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/19tests/qapi-schema: Demonstrate feature and enum doc comment bugstests/Makefile.include tests/qapi-schema/doc-bad-enum-member.err tests/qapi-schema/doc-bad-enum-member.json +7 more+89 -00 replies
2/19tests/qapi-schema: Demonstrate command and event doc comment bugstests/Makefile.include tests/qapi-schema/doc-bad-boxed-command-arg.err tests/qapi-schema/doc-bad-boxed-command-arg.json +7 more+90 -00 replies
3/19tests/qapi-schema: Cover alternate documentation commentstests/qapi-schema/doc-good.json tests/qapi-schema/doc-good.out tests/qapi-schema/doc-good.texi+37 -00 replies
4/19tests/qapi-schema: Fix feature documentation testingtests/qapi-schema/doc-bad-feature.out tests/qapi-schema/doc-good.out tests/qapi-schema/doc-undoc-feature.out +1 more+16 -00 replies
5/19qemu-doc: Belatedly document QMP command deprecationqemu-deprecated.texi+12 -00 replies
6/19qapi: Implement boxed event argument documentationscripts/qapi/doc.py tests/qapi-schema/doc-good.json tests/qapi-schema/doc-good.out +1 more+13 -40 replies
7/19qapi: De-duplicate entity documentation generation codescripts/qapi/doc.py+40 -420 replies
8/19qapi: Split .connect_doc(), .check_doc() off .check()scripts/qapi/schema.py+27 -70 replies
9/19qapi: Fix enum doc comment checkingscripts/qapi/schema.py tests/qapi-schema/doc-bad-enum-member.err tests/qapi-schema/doc-bad-enum-member.json +1 more+5 -220 replies
10/19qapi: Clean up doc comment checking for implicit union basescripts/qapi/schema.py+16 -110 replies
11/19qapi: Fix doc comment checking for commands and eventsqapi/net.json scripts/qapi/doc.py scripts/qapi/schema.py +6 more+25 -510 replies
12/19qapi: Simplify ._make_implicit_object_type()scripts/qapi/schema.py+6 -70 replies
13/19qapi: Eliminate .check_doc() overridesscripts/qapi/schema.py+2 -210 replies
14/19qapi: Fold normalize_if() into check_if()scripts/qapi/expr.py+1 -120 replies
15/19qapi: Fold normalize_features() into check_features()scripts/qapi/expr.py+2 -80 replies
16/19qapi: Fold normalize_enum() into check_enum()scripts/qapi/expr.py+2 -70 replies
17/19qapi: Lift features into QAPISchemaEntityscripts/qapi/schema.py+11 -210 replies
18/19qapi: Polish reporting of bogus member documentationscripts/qapi/parser.py tests/qapi-schema/doc-bad-alternate-member.err tests/qapi-schema/doc-bad-boxed-command-arg.err +4 more+10 -80 replies
19/19qapi: Check feature documentation against the schemascripts/qapi/parser.py scripts/qapi/schema.py tests/qapi-schema/doc-bad-feature.err +5 more+27 -510 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

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