[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 16/47] qapi-schema: Document how generated documentat
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL 16/47] qapi-schema: Document how generated documentation is ordered |
Date: |
Fri, 1 Sep 2017 14:55:40 +0200 |
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 <address@hidden>
Reviewed-by: Marc-André Lureau <address@hidden>
Message-Id: <address@hidden>
---
qapi-schema.json | 17 ++++++-----------
1 file 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
+# 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.
+
{ 'include': 'qapi/common.json' }
-
-# QAPI crypto definitions
{ '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' }
##
--
2.13.5
- [Qemu-devel] [PULL 00/47] QAPI patches for 2017-09-01, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 04/47] qdict: Add qdict_put_null() helper, and put it to use, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 16/47] qapi-schema: Document how generated documentation is ordered,
Markus Armbruster <=
- [Qemu-devel] [PULL 14/47] qlit: Tighten QLit dict vs QDict comparison, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 01/47] qapi: Fix error handling code on alternate conflict, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 03/47] qobject: Explain how QNum works, and why, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 13/47] tests/check-qlit: New, covering qobject/qlit.c, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 05/47] qlit: move qlit from check-qjson to qobject/, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 17/47] qapi-schema: Introspection doc is in the wrong section, fix, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 10/47] qlit: make qlit_equal_qobject() take const arguments, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 29/47] qapi-schema: Make block-core.json self-contained, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 07/47] qlit: Change compound literals to initializers, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 31/47] qapi-schema: Improve section headings, Markus Armbruster, 2017/09/01