[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL v2 16/47] qapi-schema: Document how generated documen
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL v2 16/47] qapi-schema: Document how generated documentation is ordered |
Date: |
Fri, 1 Sep 2017 17:37:27 +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 v2 28/47] qapi-schema: Fold event.json back into qapi-schema.json, (continued)
- [Qemu-devel] [PULL v2 28/47] qapi-schema: Fold event.json back into qapi-schema.json, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 26/47] qapi-schema: Collect TPM stuff in qapi/tpm.json, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 39/47] quorum: Use qapi_enum_parse() in quorum_open(), Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 25/47] qapi-schema: Collect transaction stuff in qapi/transaction.json, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 32/47] qapi: Update qapi-code-gen.txt examples to match current code, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 27/47] qapi-schema: Move block events from event.json to block.json, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 42/47] qapi: Avoid unnecessary use of enum lookup table's sentinel, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 06/47] qlit: use QLit prefix consistently, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 29/47] qapi-schema: Make block-core.json self-contained, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 11/47] qlit: add QLIT_QNULL and QLIT_BOOL, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 16/47] qapi-schema: Document how generated documentation is ordered,
Markus Armbruster <=
- [Qemu-devel] [PULL v2 31/47] qapi-schema: Improve section headings, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 41/47] qapi: Use qapi_enum_parse() in input_type_enum(), Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 15/47] qlit: Tighten QLit list vs QList comparison, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 45/47] qapi: Convert indirect uses of FOO_lookup[...] to qapi_enum_lookup(), Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 47/47] qapi: drop the sentinel in enum array, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 21/47] qapi-schema: Collect char device stuff in qapi/char.json, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 40/47] crypto: Use qapi_enum_parse() in qcrypto_block_luks_name_lookup(), Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 20/47] qapi-schema: Collect run state stuff in qapi/run-state.json, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 46/47] qapi: Change data type of the FOO_lookup generated for enum FOO, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL v2 38/47] block: Use qemu_enum_parse() in blkdebug_debug_breakpoint(), Markus Armbruster, 2017/09/01