Commit f3d4aa5a authored by Markus Armbruster's avatar Markus Armbruster
Browse files

qapi: Don't suppress doc generation without pragma doc-required 



Commit bc52d03f "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 fb0bc835 "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 e8ba07ea.

Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
Reviewed-by: default avatarEric Blake <eblake@redhat.com>
Message-Id: <20191018074345.24034-2-armbru@redhat.com>
parent e9d42461

scripts/qapi/doc.py

+0 −2
Original line number Diff line number Diff line
@@ -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:

tests/Makefile.include

+1 −0
Original line number Diff line number Diff line
@@ -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)