Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists1p.gnu.org (lists1p.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 0D4A1FDEE53 for ; Thu, 23 Apr 2026 22:01:29 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists1p.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1wG26E-0005gJ-Lr; Thu, 23 Apr 2026 18:00:42 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists1p.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1wG26D-0005fc-1y for qemu-devel@nongnu.org; Thu, 23 Apr 2026 18:00:41 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1wG26A-0005mH-Oo for qemu-devel@nongnu.org; Thu, 23 Apr 2026 18:00:40 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1776981635; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=TEzImYqo15Vc+v8MYBOrn3/FbYDE9JP7Gr2EmP3uAno=; b=TT1SwdoD2mMB5mQsAyB3Tyxs5bN+nFeMSggDIZ4lyUp18bPqD8XSZBiTsctnQxLTZB8S2i 9jxxw9hN7R2uOM3+bZNvStpmY/mdpyw0yfPAXuVtDTXkNYmsRXU90W/UuEkeS+GiVjrhrs yq8PqUZI4j7PuDNFfY53e+WlfYhzQnA= Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-132-_CLeo1weMNKtRlq4QIXhag-1; Thu, 23 Apr 2026 18:00:32 -0400 X-MC-Unique: _CLeo1weMNKtRlq4QIXhag-1 X-Mimecast-MFC-AGG-ID: _CLeo1weMNKtRlq4QIXhag_1776981630 Received: from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 83C9E180057D; Thu, 23 Apr 2026 22:00:30 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.64.143]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 92074300757B; Thu, 23 Apr 2026 22:00:27 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Igor Mammedov , Mauro Carvalho Chehab , "Michael S. Tsirkin" , Michael Roth , Markus Armbruster , Ani Sinha , Gerd Hoffmann , Eric Blake , Pierrick Bouvier , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Richard Henderson , Paolo Bonzini , Peter Maydell , John Snow Subject: [PATCH 01/12] tests/qapi: generate output in source order Date: Thu, 23 Apr 2026 18:00:10 -0400 Message-ID: <20260423220022.2180059-2-jsnow@redhat.com> In-Reply-To: <20260423220022.2180059-1-jsnow@redhat.com> References: <20260423220022.2180059-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 Received-SPF: pass client-ip=170.10.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Rewrite the test doc generator to produce output in source order instead of arbitrarily by section name. This patch removes our last use of the "body" field, which has an effect on how the first plaintext section of each test documented is printed: we now print "section=Plain" followed by the section text instead of "body=[...]". This patch is motivated by a desire to move the QAPIDoc API away from named fields for specific sections in a bid to force all users to simply iterate through all_sections in order, instead - and to remove the named subsections. Signed-off-by: John Snow --- tests/qapi-schema/doc-good.out | 26 +++++++++++++------------- tests/qapi-schema/test-qapi.py | 15 ++++++++------- 2 files changed, 21 insertions(+), 20 deletions(-) diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 04a55072646..e2be6f96bbf 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -54,15 +54,15 @@ event EVT_BOXED Object boxed=True feature feat3 doc freeform - body= + section=Plain ******* Section ******* doc freeform - body= + section=Plain Just text, no heading. doc freeform - body= + section=Plain Subsection ========== @@ -106,7 +106,7 @@ Examples: - *verbatim* - {braces} doc symbol=Enum - body= + section=Plain arg=one The _one_ {and only}, description on the same line @@ -119,13 +119,13 @@ a member feature section=Plain @two is undocumented doc symbol=Base - body= + section=Plain arg=base1 description starts on a new line, minimally indented doc symbol=Variant1 - body= + section=Plain A paragraph Another paragraph @@ -138,15 +138,15 @@ a feature feature=member-feat a member feature doc symbol=Variant2 - body= + section=Plain doc symbol=Object - body= + section=Plain feature=union-feat1 a feature doc symbol=Alternate - body= + section=Plain arg=i description starts on the same line @@ -157,11 +157,11 @@ description starts on the same line feature=alt-feat a feature doc freeform - body= + section=Plain Another subsection ================== doc symbol=cmd - body= + section=Plain arg=arg1 description starts on a new line, @@ -210,7 +210,7 @@ Note:: section=Since 2.10 doc symbol=cmd-boxed - body= + section=Plain If you're bored enough to read this, go see a video of boxed cats feature=cmd-feat1 a feature @@ -223,7 +223,7 @@ another feature <- ... has no title ... doc symbol=EVT_BOXED - body= + section=Plain feature=feat3 a feature diff --git a/tests/qapi-schema/test-qapi.py b/tests/qapi-schema/test-qapi.py index cf7fb8a6df5..27885147b4d 100755 --- a/tests/qapi-schema/test-qapi.py +++ b/tests/qapi-schema/test-qapi.py @@ -19,6 +19,7 @@ from io import StringIO from qapi.error import QAPIError +from qapi.parser import QAPIDoc from qapi.schema import QAPISchema, QAPISchemaVisitor @@ -116,13 +117,13 @@ def test_frontend(fname): print('doc symbol=%s' % doc.symbol) else: print('doc freeform') - print(' body=\n%s' % doc.body.text) - for arg, section in doc.args.items(): - print(' arg=%s\n%s' % (arg, section.text)) - for feat, section in doc.features.items(): - print(' feature=%s\n%s' % (feat, section.text)) - for section in doc.sections: - print(' section=%s\n%s' % (section.kind, section.text)) + for section in doc.all_sections: + if section.kind == QAPIDoc.Kind.MEMBER: + print(' arg=%s\n%s' % (section.name, section.text)) + elif section.kind == QAPIDoc.Kind.FEATURE: + print(' feature=%s\n%s' % (section.name, section.text)) + else: + print(' section=%s\n%s' % (section.kind, section.text)) def open_test_result(dir_name, file_name, update): -- 2.53.0