diff options
| author | Markus Armbruster <armbru@redhat.com> | 2019-10-18 09:43:39 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2019-10-22 09:26:12 +0200 |
| commit | f3d4aa5add400018130e2908a400e6b6a9a94f98 (patch) | |
| tree | 6ce0e9b5fee0d9ab2e34a8f00500d1b3472e8a8b | |
| parent | e9d42461920f6f40f4d847a5ba18e90d095ed0b9 (diff) | |
| download | focaccia-qemu-f3d4aa5add400018130e2908a400e6b6a9a94f98.tar.gz focaccia-qemu-f3d4aa5add400018130e2908a400e6b6a9a94f98.zip | |
qapi: Don't suppress doc generation without pragma doc-required
Commit bc52d03ff5 "qapi: Make doc comments optional where we don't need them" made scripts/qapi2texi.py fail[*] unless the schema had pragma 'doc-required': true. The stated reason was inability to cope with incomplete documentation. When commit fb0bc835e5 "qapi-gen: New common driver for code and doc generators" folded scripts/qapi2texi.py into scripts/qapi-gen.py, it turned the failure into silent suppression. The doc generator can cope with incomplete documentation now. I don't know since when, or what the problem was, or even whether it ever existed. Drop the silent suppression. [*] The fail part was broken, fixed in commit e8ba07ea9a. Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Message-Id: <20191018074345.24034-2-armbru@redhat.com>
| -rwxr-xr-x | scripts/qapi/doc.py | 2 | ||||
| -rw-r--r-- | tests/Makefile.include | 1 |
2 files changed, 1 insertions, 2 deletions
diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py index 5fc0fc7e06..693cc4486b 100755 --- a/scripts/qapi/doc.py +++ b/scripts/qapi/doc.py @@ -283,8 +283,6 @@ class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaVisitor): def gen_doc(schema, output_dir, prefix): - if not qapi.common.doc_required: - return vis = QAPISchemaGenDocVisitor(prefix) vis.visit_begin(schema) for doc in schema.docs: diff --git a/tests/Makefile.include b/tests/Makefile.include index 3543451ed3..214fbd941c 100644 --- a/tests/Makefile.include +++ b/tests/Makefile.include @@ -609,6 +609,7 @@ tests/test-qapi-gen-timestamp: \ $(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi-gen.py \ -o tests -p "test-" $<, \ "GEN","$(@:%-timestamp=%)") + @rm -f tests/test-qapi-doc.texi @>$@ tests/qapi-schema/doc-good.test.texi: $(SRC_PATH)/tests/qapi-schema/doc-good.json $(qapi-py) |