From nobody Tue Apr 7 04:21:21 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1773685676; cv=none; d=zohomail.com; s=zohoarc; b=ZQnVmCj9bXEK0TAK9aQ0NfrEsIi3PDVscO/kA+G8d9Hm+zXE+d2OmkPLFK/86mSBJkx0YRHmVj72v18KOplRKNHuD5VdrwL+wAKZ7lu7wpew2Mec5nVpeYPBW6jzp1Hir5zp9wFBROVYphWmVpiwtkxnq5fbbro31Dl6LwRDiLE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1773685676; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=lKIXJd8NRU5DR7rwShKctvPLHKRhAskhEtUKToDtb6w=; b=FIQyG1awsptOpB4WuljllbUzRnU1Xk18gEl8XY6KlOejK5EdS9h1fjt/S4XYbgMmtmuKY+f/a1HyEqN71SN0FfWOee3mbtwI9B3ZaWSflL0Ve0h0y78D/3+NRnQvYEQHygZ1jIPF9CHl/HrzvODkw61qrhKt8dbCqBONQPi+rGo= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 177368567603599.68792073925783; Mon, 16 Mar 2026 11:27:56 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1w2CfB-0002RW-TQ; Mon, 16 Mar 2026 14:27:40 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1w2Cew-0002I4-8C for qemu-devel@nongnu.org; Mon, 16 Mar 2026 14:27:22 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1w2Ceu-0007ze-IJ for qemu-devel@nongnu.org; Mon, 16 Mar 2026 14:27:21 -0400 Received: from mx-prod-mc-08.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-657-Y0IkgOI8OUWu7_U2c63WWQ-1; Mon, 16 Mar 2026 14:27:16 -0400 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-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 4E9831800365; Mon, 16 Mar 2026 18:27:14 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.66.45]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 796CD30001A2; Mon, 16 Mar 2026 18:27:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1773685639; 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=lKIXJd8NRU5DR7rwShKctvPLHKRhAskhEtUKToDtb6w=; b=OC/vh+dh3MutT5lVoNfI2hKONNw+itkgOf5E4GZso7cM6NfhfXdBiupYJk0lI/c5855m2X 6+p7ivOas+FOf7Qg29/ckbCmAa18bp4pxbovo1m2cQtW8dne3kR2Ib3s4R7SO5u8AIiI6s HRcYF6Rh65HRDpgd2fYrcHXVEnu1+XU= X-MC-Unique: Y0IkgOI8OUWu7_U2c63WWQ-1 X-Mimecast-MFC-AGG-ID: Y0IkgOI8OUWu7_U2c63WWQ_1773685634 From: John Snow To: qemu-devel@nongnu.org Cc: Pierrick Bouvier , Lukas Straub , Richard Henderson , Zhao Liu , Jason Wang , Mauro Carvalho Chehab , =?UTF-8?q?Alex=20Benn=C3=A9e?= , Peter Xu , Eric Blake , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Fabiano Rosas , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= , qemu-block@nongnu.org, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Peter Maydell , "Michael S. Tsirkin" , Stefan Berger , Alex Williamson , Marcel Apfelbaum , Kevin Wolf , John Snow , Michael Roth , Stefano Garzarella , Stefan Hajnoczi , Igor Mammedov , Jiri Pirko , Yanan Wang , Paolo Bonzini , Kashyap Chamarthy , Markus Armbruster , Hanna Reitz , Ani Sinha Subject: [PATCH 6/8] qapi: enforce doc block section ordering Date: Mon, 16 Mar 2026 14:26:05 -0400 Message-ID: <20260316182608.148628-7-jsnow@redhat.com> In-Reply-To: <20260316182608.148628-1-jsnow@redhat.com> References: <20260316182608.148628-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -3 X-Spam_score: -0.4 X-Spam_bar: / X-Spam_report: (-0.4 / 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_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.819, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.903, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=no 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1773685677544158500 Content-Type: text/plain; charset="utf-8" Ugly hack, gets the job done. Likely many simplifications can be made as a result, but I didn't make any of them. There are some inconsistencies with human-readable vs ENUM_NAMES in error messages in this patch, but it appears to work anyway. Consider this patch more of a rough idea and not anything approximating the kind of code you'd want to see from an Enterprise Linux Senior Software Engineer. Signed-off-by: John Snow --- scripts/qapi/parser.py | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 9e8dfc67208..1a7856bf213 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -545,19 +545,25 @@ def get_doc(self) -> 'QAPIDoc': self.accept(False) line =3D self.get_doc_line() have_tagged =3D False - no_more_tags =3D False + last_section =3D QAPIDoc.Kind.INTRO =20 def _tag_check(what: str) -> None: + nonlocal last_section + if what in ('TODO', 'Since'): return =20 - if no_more_tags: + this_section =3D QAPIDoc.Kind.from_string(what) + if this_section.value < last_section.value: raise QAPIParseError( self, - f"'{what}' section cannot appear after plain " - "paragraphs that follow other tagged sections\n" - "Move this section up above the plain paragraph(s)= ." + f"'{what}' section cannot appear after " + f"'{last_section!s}' section, please re-order the " + "sections and adjust phrasing as necessary to ensu= re " + "consistent documentation flow between the source " + "code and the rendered HTML manual" ) + last_section =3D this_section =20 while line is not None: # Blank lines @@ -571,7 +577,7 @@ def _tag_check(what: str) -> None: if doc.features: raise QAPIParseError( self, "duplicated 'Features:' line") - _tag_check("Features") + _tag_check("FEATURE") self.accept(False) line =3D self.get_doc_line() while line =3D=3D '': @@ -589,7 +595,7 @@ def _tag_check(what: str) -> None: self, 'feature descriptions expected') have_tagged =3D True elif line =3D=3D 'Details:': - _tag_check("Details") + _tag_check("DETAILS") self.accept(False) line =3D self.get_doc_line() while line =3D=3D '': @@ -598,6 +604,7 @@ def _tag_check(what: str) -> None: have_tagged =3D True elif match :=3D self._match_at_name_colon(line): # description + _tag_check("MEMBER") if have_tagged: raise QAPIParseError( self, @@ -654,13 +661,10 @@ def _tag_check(what: str) -> None: line =3D self.get_doc_indented(doc) have_tagged =3D True else: - # plain paragraph - if have_tagged: - no_more_tags =3D True - # Paragraphs before tagged sections are "intro" paragr= aphs. # Any appearing after are "detail" paragraphs. intro =3D not have_tagged + _tag_check("INTRO" if intro else "DETAILS") doc.ensure_untagged_section(self.info, intro) doc.append_line(line) line =3D self.get_doc_paragraph(doc) @@ -703,14 +707,17 @@ class QAPIDoc: """ =20 class Kind(enum.Enum): + # The order here is the order in which sections must appear in + # source code; with the exception of 'TODO' which may appear + # anywhere but is treated as a comment. INTRO =3D 0 MEMBER =3D 1 - FEATURE =3D 2 - RETURNS =3D 3 - ERRORS =3D 4 - SINCE =3D 5 + RETURNS =3D 2 + ERRORS =3D 3 + FEATURE =3D 4 + DETAILS =3D 5 TODO =3D 6 - DETAILS =3D 7 + SINCE =3D 7 =20 @staticmethod def from_string(kind: str) -> 'QAPIDoc.Kind': --=20 2.53.0