From: "Daniel P. Berrangé" <berrange@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Het Gala" <het.gala@nutanix.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Eric Blake" <eblake@redhat.com>,
"Michael Roth" <michael.roth@amd.com>,
"Daniel P. Berrangé" <berrange@redhat.com>
Subject: [PATCH v3 2/3] qapi: improve specificity of type/member descriptions
Date: Thu, 20 Apr 2023 11:26:18 +0100 [thread overview]
Message-ID: <20230420102619.348173-3-berrange@redhat.com> (raw)
In-Reply-To: <20230420102619.348173-1-berrange@redhat.com>
When describing member types always include the context of the
containing type. Although this is often redundant, in some cases
it will help to reduce ambiguity.
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
scripts/qapi/schema.py | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py
index 207e4d71f3..da04b97ded 100644
--- a/scripts/qapi/schema.py
+++ b/scripts/qapi/schema.py
@@ -697,6 +697,7 @@ def connect_doc(self, doc):
def describe(self, info):
role = self.role
+ meta = 'type'
defined_in = self.defined_in
assert defined_in
@@ -708,13 +709,17 @@ def describe(self, info):
# Implicit type created for a command's dict 'data'
assert role == 'member'
role = 'parameter'
+ meta = 'command'
+ defined_in = defined_in[:-4]
elif defined_in.endswith('-base'):
# Implicit type created for a union's dict 'base'
role = 'base ' + role
+ defined_in = defined_in[:-5]
else:
assert False
- elif defined_in != info.defn_name:
- return "%s '%s' of type '%s'" % (role, self.name, defined_in)
+
+ if defined_in != info.defn_name:
+ return "%s '%s' of %s '%s'" % (role, self.name, meta, defined_in)
return "%s '%s'" % (role, self.name)
--
2.40.0
next prev parent reply other threads:[~2023-04-20 10:27 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-20 10:26 [PATCH v3 0/3] qapi: allow unions to contain further unions Daniel P. Berrangé
2023-04-20 10:26 ` [PATCH v3 1/3] qapi: support updating expected test output via make Daniel P. Berrangé
2023-04-24 11:39 ` Markus Armbruster
2023-04-20 10:26 ` Daniel P. Berrangé [this message]
2023-04-24 11:38 ` [PATCH v3 2/3] qapi: improve specificity of type/member descriptions Markus Armbruster
2023-04-25 12:32 ` Daniel P. Berrangé
2023-04-25 13:17 ` Markus Armbruster
2023-04-25 13:21 ` Daniel P. Berrangé
2023-04-20 10:26 ` [PATCH v3 3/3] qapi: allow unions to contain further unions Daniel P. Berrangé
2023-04-25 13:28 ` [PATCH v3 0/3] " 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=20230420102619.348173-3-berrange@redhat.com \
--to=berrange@redhat.com \
--cc=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=het.gala@nutanix.com \
--cc=michael.roth@amd.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).