qemu-e2k/qga
Markus Armbruster bc52d03ff5 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>
2017-03-16 07:13:01 +01:00
..
installer qga: Workaround for console redirection from non-interactive qemu-ga service 2016-04-07 11:43:54 -05:00
vss-win32 rules.mak: quiet-command: Split command name and args to print 2016-10-06 12:11:51 +01:00
Makefile.objs qemu-ga: Call Windows VSS requester in fsfreeze command handler 2013-09-09 14:17:57 -05:00
channel-posix.c qga: add systemd socket activation support 2017-03-06 00:54:18 -06:00
channel-win32.c qga: add systemd socket activation support 2017-03-06 00:54:18 -06:00
channel.h qga: add systemd socket activation support 2017-03-06 00:54:18 -06:00
commands-posix.c qga: ignore EBUSY when freezing a filesystem 2017-03-06 00:54:18 -06:00
commands-win32.c qga: minimal support for fstrim for Windows guests 2016-10-31 19:09:21 -05:00
commands.c qapi: Support multiple command registries per program 2017-03-05 09:12:25 +01:00
guest-agent-command-state.c qga: free remaining leaking state 2016-09-08 17:57:32 +04:00
guest-agent-core.h qapi: Support multiple command registries per program 2017-03-05 09:12:25 +01:00
main.c qemu-ga patch queue for 2.9 2017-03-07 07:32:28 +00:00
qapi-schema.json qapi: Make doc comments optional where we don't need them 2017-03-16 07:13:01 +01:00
service-win32.c qga: Remove unnecessary glib.h includes 2016-06-07 18:19:24 +03:00
service-win32.h Clean up header guards that don't match their file name 2016-07-12 16:19:16 +02:00
vss-win32.c qga: fix w32 breakage due to missing osdep.h includes 2016-02-25 10:54:32 -06:00
vss-win32.h all: Clean up includes 2016-02-23 12:43:05 +00:00