Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1uIX5X-0000zG-Vd for mharc-qemu-trivial@gnu.org; Fri, 23 May 2025 14:25:48 -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 1uIX5V-0000ur-4T for qemu-trivial@nongnu.org; Fri, 23 May 2025 14:25:45 -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 1uIX5T-00039x-B6 for qemu-trivial@nongnu.org; Fri, 23 May 2025 14:25:44 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1748024742; 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=fA8iNN1LwEHSlpRiWf75slmpOQWaEBgpIFanj9juOH8=; b=DLZ6CP8eHdQp1PZ286MM3r59LhQMbBNG6yehZjaSMU/9pGgTry1X18lBhXWPDFeBwdYTFD K6b8WIpek4p3c4JwiNsyqTrD47ebyRnOivtQdx5WXhjA5ZBpP7EfbFZz1lTo6xmlygJSua oLJKnjCYmE4SUoJok1JfK39IpFiDPd8= 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-646-bFJWH64kPG-xvfNPHjseIg-1; Fri, 23 May 2025 14:25:39 -0400 X-MC-Unique: bFJWH64kPG-xvfNPHjseIg-1 X-Mimecast-MFC-AGG-ID: bFJWH64kPG-xvfNPHjseIg_1748024727 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-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id CB13A18004AD; Fri, 23 May 2025 18:25:25 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.64.78]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 1EF8D1944A89; Fri, 23 May 2025 18:25:14 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Kevin Wolf , Peter Maydell , Yanan Wang , Jiri Pirko , Marcel Apfelbaum , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Lukas Straub , Peter Xu , Michael Roth , Jason Wang , Stefan Hajnoczi , Eric Blake , qemu-trivial@nongnu.org, Gerd Hoffmann , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Michael Tokarev , qemu-block@nongnu.org, Mads Ynddal , "Michael S. Tsirkin" , Stefan Berger , Paolo Bonzini , John Snow , Eduardo Habkost , Fabiano Rosas , Zhao Liu , Zhenwei Pi , Ani Sinha , Markus Armbruster , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Hanna Reitz , Vladimir Sementsov-Ogievskiy , "Gonglei (Arei)" , Laurent Vivier Subject: [PATCH v3 2/4] docs, qapi: generate undocumented return sections Date: Fri, 23 May 2025 14:24:40 -0400 Message-ID: <20250523182442.54469-3-jsnow@redhat.com> In-Reply-To: <20250523182442.54469-1-jsnow@redhat.com> References: <20250523182442.54469-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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: -23 X-Spam_score: -2.4 X-Spam_bar: -- X-Spam_report: (-2.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.287, 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-trivial@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 23 May 2025 18:25:45 -0000 This patch changes the qapidoc transmogrifier to generate Return value documentation for any command that has a return value but hasn't explicitly documented that return value. Signed-off-by: John Snow --- docs/sphinx/qapidoc.py | 14 ++++++++------ scripts/qapi/parser.py | 15 +++++++++++++++ scripts/qapi/schema.py | 3 +++ 3 files changed, 26 insertions(+), 6 deletions(-) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index 8011ac9efaf..627d0b5ff1a 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -255,16 +255,18 @@ def visit_feature(self, section: QAPIDoc.ArgSection) -> None: def visit_returns(self, section: QAPIDoc.Section) -> None: assert isinstance(self.entity, QAPISchemaCommand) rtype = self.entity.ret_type - # q_empty can produce None, but we won't be documenting anything - # without an explicit return statement in the doc block, and we - # should not have any such explicit statements when there is no - # return value. + # return statements will not be present (and won't be + # autogenerated) for any command that doesn't return + # *something*, so ret_type will always be defined here. assert rtype typ = self.format_type(rtype) assert typ - assert section.text - self.add_field("return", typ, section.text, section.info) + + if section.text: + self.add_field("return", typ, section.text, section.info) + else: + self.add_lines(f":return-nodesc: {typ}", section.info) def visit_errors(self, section: QAPIDoc.Section) -> None: # FIXME: the formatting for errors may be inconsistent and may diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 949d9e8bff7..6db08f82409 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -815,6 +815,21 @@ def connect_feature(self, feature: 'QAPISchemaFeature') -> None: % feature.name) self.features[feature.name].connect(feature) + def ensure_returns(self, info: QAPISourceInfo) -> None: + if not any(s.kind == QAPIDoc.Kind.RETURNS for s in self.all_sections): + + stub = QAPIDoc.Section(info, QAPIDoc.Kind.RETURNS) + + # Stub "Returns" section for undocumented returns value. + # Insert stub after the last non-PLAIN section. + for sect in reversed(self.all_sections): + if sect.kind != QAPIDoc.Kind.PLAIN: + idx = self.all_sections.index(sect) + 1 + self.all_sections.insert(idx, stub) + break + else: + self.all_sections.append(stub) + def check_expr(self, expr: QAPIExpression) -> None: if 'command' in expr: if self.returns and 'returns' not in expr: diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py index cbe3b5aa91e..3abddea3525 100644 --- a/scripts/qapi/schema.py +++ b/scripts/qapi/schema.py @@ -1062,6 +1062,9 @@ def connect_doc(self, doc: Optional[QAPIDoc] = None) -> None: if self.arg_type and self.arg_type.is_implicit(): self.arg_type.connect_doc(doc) + if self.ret_type and self.info: + doc.ensure_returns(self.info) + def visit(self, visitor: QAPISchemaVisitor) -> None: super().visit(visitor) visitor.visit_command( -- 2.48.1