[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 1/7] qapi: Don't suppress doc generation without pragma doc-requi
From: |
Markus Armbruster |
Subject: |
[PATCH 1/7] qapi: Don't suppress doc generation without pragma doc-required |
Date: |
Tue, 1 Oct 2019 21:15:08 +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 <address@hidden>
---
scripts/qapi/doc.py | 2 --
tests/Makefile.include | 1 +
2 files changed, 1 insertion(+), 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)
--
2.21.0
- [PATCH 0/7] qapi: Cleanups and test speedup, Markus Armbruster, 2019/10/01
- [PATCH 3/7] qapi: Eliminate accidental global frontend state, Markus Armbruster, 2019/10/01
- [PATCH 7/7] qapi: Clear scripts/qapi/doc.py executable bits again, Markus Armbruster, 2019/10/01
- [PATCH 5/7] qapi: Move gen_enum(), gen_enum_lookup() back to qapi/types.py, Markus Armbruster, 2019/10/01
- [PATCH 1/7] qapi: Don't suppress doc generation without pragma doc-required,
Markus Armbruster <=
- [PATCH 2/7] qapi: Store pragma state in QAPISourceInfo, not global state, Markus Armbruster, 2019/10/01
- [PATCH 4/7] qapi: Speed up frontend tests, Markus Armbruster, 2019/10/01
- [PATCH 6/7] qapi: Split up scripts/qapi/common.py, Markus Armbruster, 2019/10/01