qapi: Require member documentation (with loophole)
authorMarkus Armbruster <armbru@redhat.com>
Mon, 5 Feb 2024 07:47:00 +0000 (08:47 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 12 Feb 2024 09:04:31 +0000 (10:04 +0100)
commit0cec50119f803723f608f6498975799ab35abf52
treeb115456fe01e28a8614b068160043332f36a21bf
parentfd62bff901b6c25df4971066b74049548caadc83
qapi: Require member documentation (with loophole)

The QAPI generator forces you to document your stuff.  Except for
command arguments, event data, and members of enum and object types:
these the generator silently "documents" as "Not documented".

We can't require proper documentation there without first fixing all
the offenders.  We've always had too many offenders to pull that off.
Right now, we have more than 500.  Worse, we seem to fix old ones no
faster than we add new ones: in the past year, we fixed 22 ones, but
added 26 new ones.

To help arrest the backsliding, make missing documentation an error
unless the command, type, or event is in listed in new pragma
documentation-exceptions.

List all the current offenders: 117 commands and types in qapi/, and 9
in qga/.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-7-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
docs/devel/qapi-code-gen.rst
qapi/pragma.json
qga/qapi-schema.json
scripts/qapi/parser.py
scripts/qapi/source.py
tests/qapi-schema/doc-bad-alternate-member.json
tests/qapi-schema/doc-good.json