]> git.proxmox.com Git - mirror_qemu.git/commitdiff
qapi: Don't suppress doc generation without pragma doc-required
authorMarkus Armbruster <armbru@redhat.com>
Fri, 18 Oct 2019 07:43:39 +0000 (09:43 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 22 Oct 2019 07:26:12 +0000 (09:26 +0200)
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>

scripts/qapi/doc.py
tests/Makefile.include

index 5fc0fc7e06d75cc6470aa0bf3de5814a329be857..693cc4486b93cd18195b85dd6d66aec31b764c5c 100755 (executable)
@@ -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:
index 3543451ed30905fb56b4555c52ee5e1cfac1d31b..214fbd941c8687bc7177934dd514e7dd3ab1d914 100644 (file)
@@ -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)