From mboxrd@z Thu Jan 1 00:00:00 1970 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 lists.gnu.org (lists.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 AABFBC28B2E for ; Mon, 10 Mar 2025 10:20:28 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1traEW-0004vA-HN; Mon, 10 Mar 2025 06:19: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 1traEU-0004u1-5P for qemu-devel@nongnu.org; Mon, 10 Mar 2025 06:19:38 -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 1traER-0007tM-Mg for qemu-devel@nongnu.org; Mon, 10 Mar 2025 06:19:37 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741601973; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=1V04zJWSMfxQfLVn2Wfju4G0wq/3yi/bM0+RtBtDDlQ=; b=gFjgIHrmIuKc9DonP+zYCgVqe/Sw2ZNB83i7gsIcZ0A6tI2I6/98autbrgUJ+6MApsTBvl L4fW4RZCX0LhGIJBhZafZrSJsleDGnBettwY+Tjfpm1zRAesn96GPz+aMfAK35OVcZgl8u EG2ZAvqfXPKb34XVptfOzSiSYw3BQ8c= 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-615--aVpzHzoPZSbriccvETrOg-1; Mon, 10 Mar 2025 06:19:30 -0400 X-MC-Unique: -aVpzHzoPZSbriccvETrOg-1 X-Mimecast-MFC-AGG-ID: -aVpzHzoPZSbriccvETrOg_1741601969 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (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 71A63180035D; Mon, 10 Mar 2025 10:19:28 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.44.22.4]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id DBD2E19560AD; Mon, 10 Mar 2025 10:19:27 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 5D17821E66C4; Mon, 10 Mar 2025 11:19:25 +0100 (CET) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Michael Roth , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Eric Blake , Thomas Huth , Alex =?utf-8?Q?Benn=C3=A9e?= , Peter Maydell Subject: Re: [PATCH v2 59/62] qapi/parser: add undocumented stub members to all_sections In-Reply-To: <20250309083550.5155-60-jsnow@redhat.com> (John Snow's message of "Sun, 9 Mar 2025 04:35:46 -0400") References: <20250309083550.5155-1-jsnow@redhat.com> <20250309083550.5155-60-jsnow@redhat.com> Date: Mon, 10 Mar 2025 11:19:25 +0100 Message-ID: <871pv52no2.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@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, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=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: 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 John Snow writes: > This helps simplify the new doc generator if it doesn't have to check > for undocumented members, it can just blindly operate on a sequence of > QAPIDoc.Section instances. > > NB: If there is no existing 'member' section, these undocumented stub > members will be inserted directly after the leading section. > > Signed-off-by: John Snow > --- > scripts/qapi/parser.py | 15 ++++++++++++++- > 1 file changed, 14 insertions(+), 1 deletion(-) > > diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py > index 11c11bb09e5..58cb9f41ae8 100644 > --- a/scripts/qapi/parser.py > +++ b/scripts/qapi/parser.py > @@ -789,8 +789,21 @@ def connect_member(self, member: 'QAPISchemaMember') -> None: > raise QAPISemError(member.info, > "%s '%s' lacks documentation" > % (member.role, member.name)) > - self.args[member.name] = QAPIDoc.ArgSection( > + section = QAPIDoc.ArgSection( > self.info, QAPIDoc.Kind.MEMBER, member.name) > + self.args[member.name] = section > + > + # Insert stub documentation section for missing member docs. > + # Determine where to insert stub doc - it should go at the > + # end of the members section(s), if any. Note that index 0 > + # is assumed to be an untagged intro section, even if it is > + # empty. Please add # TODO drop when undocumented members are outlawed > + index = 1 > + if len(self.all_sections) > 1: > + while self.all_sections[index].kind == QAPIDoc.Kind.MEMBER: > + index += 1 > + self.all_sections.insert(index, section) > + > self.args[member.name].connect(member) > > def connect_feature(self, feature: 'QAPISchemaFeature') -> None: