diff options
| author | Markus Armbruster <armbru@redhat.com> | 2017-03-15 13:56:51 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-03-16 07:13:01 +0100 |
| commit | bc52d03ff589a033843b4603cfdfd1518867c626 (patch) | |
| tree | 8196974ce1a4777947853ad331a97e5834bb19fc /qga/qapi-schema.json | |
| parent | e04dea88727c2ac97091333ac8be6af5952634a7 (diff) | |
qapi: Make doc comments optional where we don't need them
Since we added the documentation generator in commit 3313b61, doc
comments are mandatory. That's a very good idea for a schema that
needs to be documented, but has proven to be annoying for testing.
Make doc comments optional again, but add a new directive
{ 'pragma': { 'doc-required': true } }
to let a QAPI schema require them.
Add test cases for the new pragma directive. While there, plug a
minor hole in includ directive test coverage.
Require documentation in the schemas we actually want documented:
qapi-schema.json and qga/qapi-schema.json.
We could probably make qapi2texi.py cope with incomplete
documentation, but for now, simply make it refuse to run unless the
schema has 'doc-required': true.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <1489582656-31133-3-git-send-email-armbru@redhat.com>
[qapi-code-gen.txt wording tweaked]
Reviewed-by: Eric Blake <eblake@redhat.com>
Diffstat (limited to 'qga/qapi-schema.json')
| -rw-r--r-- | qga/qapi-schema.json | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index d421609dcb..3f3d428fce 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -11,6 +11,8 @@ # ## +{ 'pragma': { 'doc-required': true } } + ## # @guest-sync-delimited: # |