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
2017-03-02 07:31:26 +02:00
2016-07-25 13:23:18 -05:00
2017-03-10 15:05:22 +08:00
2015-12-17 13:37:15 +00:00
2016-02-08 17:29:54 +01:00
2017-03-01 11:58:57 +04:00
2016-07-22 13:23:39 +05:30
2015-01-26 12:22:44 +01:00
2017-03-16 07:13:01 +01:00
2017-03-13 12:49:33 +01:00
2015-07-07 13:13:22 +01:00
2017-02-14 08:14:58 +11:00
2014-06-23 19:14:52 +02:00
2017-03-07 16:07:47 +01:00
2016-06-07 18:19:24 +03:00
2017-03-02 07:14:27 +02:00
2017-03-02 07:14:27 +02:00
2016-11-14 11:15:55 -05:00
2016-10-26 08:29:01 -07:00
2017-03-03 10:09:03 +00:00
2016-06-07 18:19:24 +03:00
2016-10-14 10:06:47 +11:00
2016-10-14 10:06:47 +11:00
2017-03-03 11:30:59 +11:00
2016-09-23 13:36:09 +02:00
2017-02-22 19:52:01 +01:00
2016-06-07 18:19:24 +03:00
2016-06-07 18:19:24 +03:00
2017-03-07 16:07:47 +01:00
2016-06-07 18:19:24 +03:00
2017-03-05 09:14:19 +01:00
2016-09-08 17:57:32 +04:00
2016-09-08 17:57:32 +04:00
2016-06-07 18:19:24 +03:00
2016-02-16 14:29:27 +00:00
2016-10-28 18:17:24 +03:00
2017-01-16 17:52:34 +01:00
2017-01-31 10:10:13 +11:00
2016-07-29 14:14:15 +10:00
2016-06-07 18:19:24 +03:00
2017-03-01 11:51:28 +04:00
2017-03-01 11:51:28 +04:00
2017-03-01 11:51:05 +04:00
2017-03-01 00:09:28 +04:00
2016-06-07 18:19:24 +03:00
2016-06-07 18:19:24 +03:00
2016-06-07 18:19:24 +03:00
2017-03-01 11:51:04 +04:00
2017-03-01 11:51:28 +04:00
2016-06-07 18:19:24 +03:00
2017-03-01 11:51:04 +04:00
2016-06-20 16:38:13 +02:00
2016-03-22 22:20:15 +01:00
2015-12-18 12:18:31 +00:00
2016-06-07 18:19:24 +03:00
2017-02-21 11:14:07 +00:00
2017-02-21 11:14:07 +00:00
2017-03-01 11:51:05 +04:00
2017-03-01 11:51:05 +04:00
2016-06-07 18:19:24 +03:00
2017-01-31 10:10:13 +11:00
2017-03-07 16:07:47 +01:00
2017-03-05 09:02:10 +01:00
2017-01-20 11:15:08 +00:00
2016-06-07 18:19:24 +03:00
2017-03-16 07:13:01 +01:00
2016-06-07 18:19:24 +03:00
2016-06-07 18:19:24 +03:00
2016-09-08 18:05:22 +04:00
2016-06-07 18:19:24 +03:00
2016-10-19 10:09:24 +01:00
2017-03-03 11:30:59 +11:00
2017-03-01 00:09:28 +04:00
2017-02-28 09:03:39 +03:00
2017-03-01 00:09:28 +04:00
2017-03-01 00:09:28 +04:00
2016-10-24 16:26:53 +01:00
2017-03-01 00:09:28 +04:00
2016-10-14 10:06:47 +11:00
2017-03-01 11:50:33 +04:00
2015-01-13 11:47:55 +00:00
2016-10-24 15:27:19 +02:00
2017-03-05 09:14:19 +01:00
2016-09-08 18:05:21 +04:00
2016-06-07 18:19:24 +03:00
2016-10-28 09:36:58 +11:00
2016-06-07 18:19:24 +03:00
2016-10-28 09:38:27 +11:00
2016-10-16 12:04:15 +11:00
2017-03-01 11:51:25 +04:00
2017-03-14 13:28:29 +01:00
2017-03-14 13:28:29 +01:00
2016-10-24 16:26:54 +01:00
2016-06-07 18:19:24 +03:00
2017-01-10 08:49:59 -08:00
2016-06-17 15:23:51 +01:00
2017-02-28 20:40:37 +01:00
2017-02-28 20:47:50 +01:00
2016-09-13 19:13:32 +02:00
2017-01-27 18:07:59 +01:00
2016-07-06 10:52:04 +02:00
2016-09-28 17:11:23 +01:00
2016-03-22 22:20:15 +01:00
2016-09-23 11:42:52 +08:00
2016-12-21 14:26:26 +00:00
2016-10-19 10:23:55 +01:00
2016-12-22 09:24:59 +00:00
2016-03-22 22:20:15 +01:00
2016-09-19 16:30:45 +01:00
2016-06-13 12:41:17 +01:00
2016-03-22 22:20:15 +01:00
2016-03-22 22:20:15 +01:00
2016-07-04 10:46:59 +01:00
2017-02-23 20:35:36 +01:00
2017-03-01 00:09:28 +04:00
2017-03-01 00:09:28 +04:00
2017-01-26 10:25:01 +08:00
2016-10-26 08:29:00 -07:00
2016-02-16 14:29:27 +00:00
2017-03-01 00:09:28 +04:00
2016-03-22 22:20:15 +01:00
2017-01-23 15:32:18 +00:00
2017-01-23 15:32:18 +00:00
2017-01-26 10:26:18 +00:00
2016-09-08 17:57:32 +04:00
2017-03-07 16:07:48 +01:00
2016-08-19 12:44:11 +01:00
2016-06-07 18:19:24 +03:00
2016-06-07 18:19:24 +03:00
2017-03-05 09:14:20 +01:00
2017-03-07 16:07:47 +01:00
2016-06-07 18:19:24 +03:00
2016-08-03 18:44:56 +02:00
2017-03-15 08:52:09 +01:00
2017-03-07 07:32:28 +00:00
2016-06-16 18:39:03 +02:00
2016-10-06 18:04:13 +02:00
2017-03-05 09:14:19 +01:00
2017-02-22 19:51:59 +01:00
2017-03-07 16:07:47 +01:00
2017-03-15 08:52:09 +01:00
2016-06-07 18:19:24 +03:00
2016-11-15 15:41:00 +00:00
2017-01-31 10:10:14 +11:00
2017-03-05 09:14:20 +01:00
2016-10-25 16:25:48 +02:00
2017-02-21 11:14:07 +00:00
2017-02-28 20:47:50 +01:00
2016-06-07 18:19:24 +03:00
2016-11-11 20:53:23 +08:00
2017-03-07 16:07:47 +01:00
2017-02-28 11:30:22 +00:00
2016-06-07 18:19:24 +03:00
2016-10-31 16:20:59 -02:00
2016-06-07 18:19:24 +03:00
2016-03-22 22:20:17 +01:00
2016-06-07 18:19:24 +03:00
2016-06-07 18:19:24 +03:00
2017-03-01 11:51:29 +04:00
2016-06-07 18:19:24 +03:00
2017-03-01 11:51:29 +04:00
2016-06-07 18:19:24 +03:00
2016-12-16 01:14:38 +02:00
2017-03-01 11:51:00 +04:00
2017-03-01 11:51:28 +04:00
2016-06-07 18:19:24 +03:00
2017-03-01 11:58:57 +04:00
2016-06-20 16:38:13 +02:00
2016-10-28 09:36:58 +11:00
2016-10-28 09:36:58 +11:00
2017-03-01 11:51:28 +04:00
2016-06-07 18:19:24 +03:00
2016-06-07 18:19:24 +03:00
2016-06-20 16:38:13 +02:00
bc52d03ff5