diff options
| author | Markus Armbruster | 2017-03-15 13:57:06 +0100 |
|---|---|---|
| committer | Markus Armbruster | 2017-03-16 07:13:02 +0100 |
| commit | 1d8bda128d2ff1f7e589c90d0ac468b95d260757 (patch) | |
| tree | 697f7ef26b1d5d4fb2fbfc9022e2c4122fe6e237 /tests/Makefile.include | |
| parent | qapi2texi: Convert to QAPISchemaVisitor (diff) | |
| download | qemu-1d8bda128d2ff1f7e589c90d0ac468b95d260757.tar.gz qemu-1d8bda128d2ff1f7e589c90d0ac468b95d260757.tar.xz qemu-1d8bda128d2ff1f7e589c90d0ac468b95d260757.zip | |
qapi: The #optional tag is redundant, drop
We traditionally mark optional members #optional in the doc comment.
Before commit 3313b61, this was entirely manual.
Commit 3313b61 added some automation because its qapi2texi.py relied
on #optional to determine whether a member is optional. This is no
longer the case since the previous commit: the only thing qapi2texi.py
still does with #optional is stripping it out. We still reject bogus
qapi-schema.json and six places for qga/qapi-schema.json.
Thus, you can't actually rely on #optional to see whether something is
optional. Yet we still make people add it manually. That's just
busy-work.
Drop the code to check, fix up and strip out #optional, along with all
instances of #optional. To keep it out, add code to reject it, to be
dropped again once the dust settles.
No change to generated documentation.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-18-git-send-email-armbru@redhat.com>
Diffstat (limited to 'tests/Makefile.include')
| -rw-r--r-- | tests/Makefile.include | 1 |
1 files changed, 0 insertions, 1 deletions
diff --git a/tests/Makefile.include b/tests/Makefile.include index 3e640a846c..00b02fd19c 100644 --- a/tests/Makefile.include +++ b/tests/Makefile.include @@ -385,7 +385,6 @@ qapi-schema += doc-missing.json qapi-schema += doc-missing-colon.json qapi-schema += doc-missing-expr.json qapi-schema += doc-missing-space.json -qapi-schema += doc-optional.json qapi-schema += double-data.json qapi-schema += double-type.json qapi-schema += duplicate-key.json |