From nobody Wed Nov 5 08:54:31 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1504281588391822.1453816005036; Fri, 1 Sep 2017 08:59:48 -0700 (PDT) Received: from localhost ([::1]:46579 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dnoMF-00035K-Bx for importer@patchew.org; Fri, 01 Sep 2017 11:59:47 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:51583) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dno1O-0006fv-DI for qemu-devel@nongnu.org; Fri, 01 Sep 2017 11:38:22 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dno1J-0001fP-Ed for qemu-devel@nongnu.org; Fri, 01 Sep 2017 11:38:14 -0400 Received: from mx1.redhat.com ([209.132.183.28]:60520) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dno1J-0001eP-8K for qemu-devel@nongnu.org; Fri, 01 Sep 2017 11:38:09 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 4589CC0467DB for ; Fri, 1 Sep 2017 15:38:08 +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 11D5981F92 for ; Fri, 1 Sep 2017 15:38:08 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 71AAA1138546; Fri, 1 Sep 2017 17:37:58 +0200 (CEST) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 4589CC0467DB Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; spf=fail smtp.mailfrom=armbru@redhat.com From: Markus Armbruster To: qemu-devel@nongnu.org Date: Fri, 1 Sep 2017 17:37:27 +0200 Message-Id: <20170901153758.8628-17-armbru@redhat.com> In-Reply-To: <20170901153758.8628-1-armbru@redhat.com> References: <20170901153758.8628-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Fri, 01 Sep 2017 15:38:08 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PULL v2 16/47] qapi-schema: Document how generated documentation is ordered X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" 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