[PATCH 00/19] qapi: Doc generation fixes

Markus Armbruster posted 19 patches 4 years, 6 months ago
Test asan passed
Test checkpatch passed
Test FreeBSD passed
Test docker-mingw@fedora passed
Test docker-clang@ubuntu passed
Test docker-quick@centos7 passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20191024110237.30963-1-armbru@redhat.com
Maintainers: Jason Wang <jasowang@redhat.com>, Markus Armbruster <armbru@redhat.com>, Michael Roth <mdroth@linux.vnet.ibm.com>, Eric Blake <eblake@redhat.com>
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
[PATCH 00/19] qapi: Doc generation fixes
Posted by Markus Armbruster 4 years, 6 months ago
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