aboutsummaryrefslogtreecommitdiff
path: root/qapi/introspect.json
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2015-09-16 13:06:29 +0200
committerMarkus Armbruster <armbru@redhat.com>2015-09-21 09:56:49 +0200
commit1a9a507b2e3e90aa719c96b4c092e7fad7215f21 (patch)
tree9b6a5f1a5783fb9f151d17b554c3f8117c52e08b /qapi/introspect.json
parent39a181581650f4d50f4445bc6276d9716cece050 (diff)
qapi-introspect: Hide type names
To eliminate the temptation for clients to look up types by name (which are not ABI), replace all type names by meaningless strings. Reduces output of query-schema by 13 out of 85KiB. As a debugging aid, provide option -u to suppress the hiding. Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Message-Id: <1442401589-24189-27-git-send-email-armbru@redhat.com>
Diffstat (limited to 'qapi/introspect.json')
-rw-r--r--qapi/introspect.json12
1 files changed, 4 insertions, 8 deletions
diff --git a/qapi/introspect.json b/qapi/introspect.json
index 9c8ad53d7a..cc50dc6bcb 100644
--- a/qapi/introspect.json
+++ b/qapi/introspect.json
@@ -75,17 +75,13 @@
# @SchemaInfo
#
# @name: the entity's name, inherited from @base.
-# Entities defined in the QAPI schema have the name defined in
-# the schema. Implicitly defined entities have generated
-# names. See docs/qapi-code-gen.txt section "Client JSON
-# Protocol introspection" for details.
+# Commands and events have the name defined in the QAPI schema.
+# Unlike command and event names, type names are not part of
+# the wire ABI. Consequently, type names are meaningless
+# strings here.
#
# All references to other SchemaInfo are by name.
#
-# Command and event names are part of the wire ABI, but type names are
-# not. Therefore, looking up a type by "well-known" name is wrong.
-# Look up the command or event, then follow the references.
-#
# @meta-type: the entity's meta type, inherited from @base.
#
# Additional members depend on the value of @meta-type.