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 4BD56C28B2E for ; Sun, 9 Mar 2025 21:11:08 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1trNvB-0000tk-K8; Sun, 09 Mar 2025 17:10:53 -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 1trNv8-0000qI-N4 for qemu-devel@nongnu.org; Sun, 09 Mar 2025 17:10:50 -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 1trNv6-0004SU-Lc for qemu-devel@nongnu.org; Sun, 09 Mar 2025 17:10:50 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741554647; 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=mXWVOCnEzKRlyjAIKXCvCRlhPjAo76gPqqeJOMktOhk=; b=UhNWKznfbBsP723VPHHrqW6+118GcGSuV3zDBSOyAqwqzBFghV/lw8bDTghVYLgRi+vIj0 WJoP/1xJdRg9qVdbcqjmK/Bt3cHsKQwAJYTtPfiQcKv4W+312pCrZY4TOFkY6DV43aSRtL f4v33spLDBXDZ4UimW1ihFhKfHHuz38= Received: from mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-441-LDnj99Y-Orac5ndbOuR3tg-1; Sun, 09 Mar 2025 17:10:46 -0400 X-MC-Unique: LDnj99Y-Orac5ndbOuR3tg-1 X-Mimecast-MFC-AGG-ID: LDnj99Y-Orac5ndbOuR3tg_1741554645 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (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-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 2440D19560B0; Sun, 9 Mar 2025 21:10:45 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.44.22.4]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id B0F1A1956094; Sun, 9 Mar 2025 21:10:44 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 3430721E675F; Sun, 09 Mar 2025 22:10:42 +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 52/62] docs/qapidoc: add visit_sections() method In-Reply-To: <20250309083550.5155-53-jsnow@redhat.com> (John Snow's message of "Sun, 9 Mar 2025 04:35:39 -0400") References: <20250309083550.5155-1-jsnow@redhat.com> <20250309083550.5155-53-jsnow@redhat.com> Date: Sun, 09 Mar 2025 22:10:42 +0100 Message-ID: <87cyepykod.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.15 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: > Implement the actual main dispatch method that processes and handles the > list of doc sections for a given QAPI entity. > > Signed-off-by: John Snow > --- > docs/sphinx/qapidoc.py | 25 +++++++++++++++++++++++++ > 1 file changed, 25 insertions(+) > > diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py > index db11c2ae933..78bec91271f 100644 > --- a/docs/sphinx/qapidoc.py > +++ b/docs/sphinx/qapidoc.py > @@ -288,6 +288,31 @@ def preamble(self, ent: QAPISchemaDefinition) -> None: > > self.ensure_blank_line() > > + def visit_sections(self, ent: QAPISchemaDefinition) -> None: > + sections = ent.doc.all_sections if ent.doc else [] > + > + # Add sections *in the order they are documented*: Would # Add sections in source order be clearer? > + for section in sections: > + if section.kind == QAPIDoc.Kind.PLAIN: > + self.visit_paragraph(section) > + elif section.kind == QAPIDoc.Kind.MEMBER: > + assert isinstance(section, QAPIDoc.ArgSection) > + self.visit_member(section) > + elif section.kind == QAPIDoc.Kind.FEATURE: > + assert isinstance(section, QAPIDoc.ArgSection) > + self.visit_feature(section) > + elif section.kind in (QAPIDoc.Kind.SINCE, QAPIDoc.Kind.TODO): > + # Since is handled in preamble, TODO is skipped intentionally. > + pass > + elif section.kind == QAPIDoc.Kind.RETURNS: > + self.visit_returns(section) > + elif section.kind == QAPIDoc.Kind.ERRORS: > + self.visit_errors(section) > + else: > + assert False > + > + self.ensure_blank_line() > + > # Transmogrification core methods > > def visit_module(self, path: str) -> None: