[v2] qapi: easier debugging of introspection file

[Qemu-devel] [PATCH v2 0/2] qapi: easier debugging of introspection file

Eric Blake posted 2 patches 7 years, 1 month ago

Diff against v1
Download series mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20180827213943.33524-1-eblake@redhat.com

Test docker-clang@ubuntu failed

Test checkpatch passed

docs/devel/qapi-code-gen.txt |  1 +
scripts/qapi/introspect.py   | 34 ++++++++++++++++++++++++----------
2 files changed, 25 insertions(+), 10 deletions(-)

Expand all Fold all

[Qemu-devel] [PATCH v2 0/2] qapi: easier debugging of introspection file

Posted by Eric Blake 7 years, 1 month ago

When inspecting the generated qapi-introspect.c (for debugging,
or to see what QAPI changes are user visible vs. internal only),
the fact that we've intentionally masked names from the QMP client
makes it harder to tie back generated code back to the original
QAPI .json files.  We have a -u switch to qapi-gen for temporarily
bypassing the name masking, but that's a rather heavy-handed
tactic just for some temporary debugging.  Better is to just make
the generated file include strategic comments.

v1 was sent back in June, but was stalled due to 3.0 hard freeze.
Now that 3.1 is open, it's time to revisit this.

Since then:
- drop the original patch 2 (deleting --unmask proved controversial) [Markus]
- rebase patch on top of Marc-Andre's conditional work [Markus]
- update documentation to match code change [Eric]
- split out a preliminary cleanup patch [pep8]

Eric Blake (2):
  qapi: Minor introspect.py cleanups
  qapi: Add comments to aid debugging generated introspection

 docs/devel/qapi-code-gen.txt |  1 +
 scripts/qapi/introspect.py   | 34 ++++++++++++++++++++++++----------
 2 files changed, 25 insertions(+), 10 deletions(-)

-- 
2.17.1

Re: [Qemu-devel] [PATCH v2 0/2] qapi: easier debugging of introspection file

Posted by Markus Armbruster 7 years, 1 month ago

Eric Blake <eblake@redhat.com> writes:

> When inspecting the generated qapi-introspect.c (for debugging,
> or to see what QAPI changes are user visible vs. internal only),
> the fact that we've intentionally masked names from the QMP client
> makes it harder to tie back generated code back to the original
> QAPI .json files.  We have a -u switch to qapi-gen for temporarily
> bypassing the name masking, but that's a rather heavy-handed
> tactic just for some temporary debugging.  Better is to just make
> the generated file include strategic comments.
>
> v1 was sent back in June, but was stalled due to 3.0 hard freeze.
> Now that 3.1 is open, it's time to revisit this.
>
> Since then:
> - drop the original patch 2 (deleting --unmask proved controversial) [Markus]
> - rebase patch on top of Marc-Andre's conditional work [Markus]
> - update documentation to match code change [Eric]
> - split out a preliminary cleanup patch [pep8]

Queued.  Thanks!