From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:53823) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dnlUi-0000F2-1m for qemu-devel@nongnu.org; Fri, 01 Sep 2017 08:56:22 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dnlUg-0007Jc-Sg for qemu-devel@nongnu.org; Fri, 01 Sep 2017 08:56:20 -0400 Received: from mx1.redhat.com ([209.132.183.28]:60900) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dnlUg-0007J7-Nb for qemu-devel@nongnu.org; Fri, 01 Sep 2017 08:56:18 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id BB43C369C4 for ; Fri, 1 Sep 2017 12:56:17 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-116-75.ams2.redhat.com [10.36.116.75]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 895E0A63AB for ; Fri, 1 Sep 2017 12:56:17 +0000 (UTC) From: Markus Armbruster Date: Fri, 1 Sep 2017 14:55:40 +0200 Message-Id: <20170901125611.29295-17-armbru@redhat.com> In-Reply-To: <20170901125611.29295-1-armbru@redhat.com> References: <20170901125611.29295-1-armbru@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Subject: [Qemu-devel] [PULL 16/47] qapi-schema: Document how generated documentation is ordered List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org 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 Reviewed-by: Marc-Andr=C3=A9 Lureau Message-Id: <1503602048-12268-2-git-send-email-armbru@redhat.com> --- 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 ] } } =20 -# 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' } =20 ## --=20 2.13.5