aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2017-08-24 21:13:53 +0200
committerMarkus Armbruster <armbru@redhat.com>2017-09-04 13:09:12 +0200
commit211e5063be7ffc34ed1daaa4a1aa5f5cfb039995 (patch)
treea8cf84e8b53617444621e2939e19c465581cc7c4
parentcbb654052600c376d5ee3401c98a25d09d11a154 (diff)
downloadqemu-arm-211e5063be7ffc34ed1daaa4a1aa5f5cfb039995.tar.gz
qapi-schema: Document how generated documentation is ordered
Documentation generated with qapi2texi.py is in source order, with included sub-schemas inserted at the first include directive (subsequent include directives have no effect). To get a sane and stable order, it's best to include each sub-schema just once, or include it first in qapi-schema.json. Document that. While there, drop a few redundant comments. Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com> Message-Id: <1503602048-12268-2-git-send-email-armbru@redhat.com>
-rw-r--r--qapi-schema.json17
1 files changed, 6 insertions, 11 deletions
diff --git a/qapi-schema.json b/qapi-schema.json
index 802ea53d00..3db3d1972f 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -72,22 +72,17 @@
'q_obj_CpuInfo-base' # CPU, visible through query-cpu
] } }
-# QAPI common definitions
-{ 'include': 'qapi/common.json' }
+# Documentation generated with qapi2texi.py is in source order, with
+# included sub-schemas inserted at the first include directive
+# (subsequent include directives have no effect). To get a sane and
+# stable order, it's best to include each sub-schema just once, or
+# include it first in qapi-schema.json.
-# QAPI crypto definitions
+{ 'include': 'qapi/common.json' }
{ 'include': 'qapi/crypto.json' }
-
-# QAPI block definitions
{ 'include': 'qapi/block.json' }
-
-# QAPI event definitions
{ 'include': 'qapi/event.json' }
-
-# Tracing commands
{ 'include': 'qapi/trace.json' }
-
-# QAPI introspection
{ 'include': 'qapi/introspect.json' }
##