<feed xmlns='http://www.w3.org/2005/Atom'>
<title>bwlp/qemu.git/tests/qapi-schema/pragma-non-dict.out, branch spice_video_codecs</title>
<subtitle>Experimental fork of QEMU with video encoding patches</subtitle>
<id>https://git.openslx.org/bwlp/qemu.git/atom/tests/qapi-schema/pragma-non-dict.out?h=spice_video_codecs</id>
<link rel='self' href='https://git.openslx.org/bwlp/qemu.git/atom/tests/qapi-schema/pragma-non-dict.out?h=spice_video_codecs'/>
<link rel='alternate' type='text/html' href='https://git.openslx.org/bwlp/qemu.git/'/>
<updated>2017-03-16T06:13:01+00:00</updated>
<entry>
<title>qapi: Make doc comments optional where we don't need them</title>
<updated>2017-03-16T06:13:01+00:00</updated>
<author>
<name>Markus Armbruster</name>
</author>
<published>2017-03-15T12:56:51+00:00</published>
<link rel='alternate' type='text/html' href='https://git.openslx.org/bwlp/qemu.git/commit/?id=bc52d03ff589a033843b4603cfdfd1518867c626'/>
<id>urn:sha1:bc52d03ff589a033843b4603cfdfd1518867c626</id>
<content type='text'>
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 &lt;armbru@redhat.com&gt;
Message-Id: &lt;1489582656-31133-3-git-send-email-armbru@redhat.com&gt;
[qapi-code-gen.txt wording tweaked]
Reviewed-by: Eric Blake &lt;eblake@redhat.com&gt;
</content>
</entry>
</feed>
