From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Subject: [PULL 01/12] qapi: Don't suppress doc generation without pragma doc-required
Date: Tue, 22 Oct 2019 09:56:04 +0200 [thread overview]
Message-ID: <20191022075615.956-2-armbru@redhat.com> (raw)
In-Reply-To: <20191022075615.956-1-armbru@redhat.com>
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 | 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
next prev parent reply other threads:[~2019-10-22 8:00 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-22 7:56 [PULL 00/12] QAPI patches for 2019-10-22 Markus Armbruster
2019-10-22 7:56 ` Markus Armbruster [this message]
2019-10-22 7:56 ` [PULL 02/12] qapi: Store pragma state in QAPISourceInfo, not global state Markus Armbruster
2019-10-22 7:56 ` [PULL 03/12] qapi: Eliminate accidental global frontend state Markus Armbruster
2019-10-22 7:56 ` [PULL 04/12] qapi: Speed up frontend tests Markus Armbruster
2019-10-22 7:56 ` [PULL 05/12] qapi: Move gen_enum(), gen_enum_lookup() back to qapi/types.py Markus Armbruster
2019-10-22 7:56 ` [PULL 06/12] qapi: Split up scripts/qapi/common.py Markus Armbruster
2019-10-22 7:56 ` [PULL 07/12] qapi: Clear scripts/qapi/doc.py executable bits again Markus Armbruster
2019-10-22 7:56 ` [PULL 08/12] tests/qapi-schema: Tidy up test output indentation Markus Armbruster
2019-10-22 7:56 ` [PULL 09/12] qapi: Add feature flags to commands Markus Armbruster
2019-10-22 7:56 ` [PULL 10/12] tests: qapi: Test 'features' of commands Markus Armbruster
2019-10-22 7:56 ` [PULL 11/12] tests/qapi-schema: Cover feature documentation comments Markus Armbruster
2019-10-22 7:56 ` [PULL 12/12] qapi: Allow introspecting fix for savevm's cooperation with blockdev Markus Armbruster
2019-10-22 9:32 ` [PULL 00/12] QAPI patches for 2019-10-22 Peter Maydell
2019-10-22 10:49 ` Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191022075615.956-2-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.