From nobody Mon Nov 25 03:36:24 2024 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=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1718757122; cv=none; d=zohomail.com; s=zohoarc; b=I4rN2c8IzPofK8+pR0T+c6VwaL6yZd76xhCCpujvarEMzYqMoYoM7OJuDY1qMAsTBmNFnrSbstfoDlpMSZK4CI8byEsIc2VmQMa1VdzQZnbzcmy6L/LJlPdpOxvW+6r2Nj9nLUstovEqrSSZJikV5EAsJ7/Q9kfMAmhHznO62DM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1718757122; 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=t7v4IUwQ2Vu8HBDp7pZw63iLhIi04GcZUKA2Bhf20o8=; b=W5yRBm97N5YWsymaUBSjnWegawYM3RfS85GkZgsKGNLr9WSQji9mOsT4UBZ1Vgct5DNZ87l95odSPFAhHN0JXxOTQcobTT6OZx64Fty5RtT1+WMytYVezlJ1PlVV8N3Kt4y5j3v3vKNkZWoQVhebjFfYDYjUYki5PX3Y1g+uNG4= 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=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1718757122491642.5155541510449; Tue, 18 Jun 2024 17:32:02 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sJjEJ-0006GS-55; Tue, 18 Jun 2024 20:31:15 -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 1sJjEI-0006Fr-4J for qemu-devel@nongnu.org; Tue, 18 Jun 2024 20:31:14 -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 1sJjEG-0001Pf-9S for qemu-devel@nongnu.org; Tue, 18 Jun 2024 20:31:13 -0400 Received: from mx-prod-mc-05.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-620-Hb3_E5i6MRydAjF8NvPkzw-1; Tue, 18 Jun 2024 20:31:07 -0400 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-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id B3F731956083; Wed, 19 Jun 2024 00:31:04 +0000 (UTC) Received: from scv.localdomain (unknown [10.22.16.38]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 587351955E80; Wed, 19 Jun 2024 00:30:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1718757071; 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=t7v4IUwQ2Vu8HBDp7pZw63iLhIi04GcZUKA2Bhf20o8=; b=ASt40aAaJsRLhyG5hJHk2fvorAYDkovkajki61kLXEPqI1a0+jsEX/aoUgdR+7Wp7A5zYK T4Hm4oZQfsqYGVe3U1uTKtsyi5GmJiQOSuf5tFbxmtTiySxE16NbhgTdF+u2jVQch8o29b YdzPGIxHulrP0MdYcD3b/M5Ohng3GYM= X-MC-Unique: Hb3_E5i6MRydAjF8NvPkzw-1 From: John Snow To: qemu-devel@nongnu.org Cc: Stefan Hajnoczi , Hanna Reitz , Michael Roth , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Victor Toso de Carvalho , "Michael S. Tsirkin" , Konstantin Kostiuk , Yanan Wang , Pavel Dovgalyuk , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Marcel Apfelbaum , Fabiano Rosas , Lukas Straub , Eduardo Habkost , Mads Ynddal , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Gerd Hoffmann , Stefan Berger , Peter Xu , Igor Mammedov , =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= , Jason Wang , Ani Sinha , Markus Armbruster , Paolo Bonzini , Peter Maydell , qemu-block@nongnu.org, Jiri Pirko , Alex Williamson , Kevin Wolf , Eric Blake , John Snow Subject: [PATCH 04/13] qapi/parser: preserve indentation in QAPIDoc sections Date: Tue, 18 Jun 2024 20:30:03 -0400 Message-ID: <20240619003012.1753577-5-jsnow@redhat.com> In-Reply-To: <20240619003012.1753577-1-jsnow@redhat.com> References: <20240619003012.1753577-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 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.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: 11 X-Spam_score: 1.1 X-Spam_bar: + X-Spam_report: (1.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.148, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_SBL_CSS=3.335, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 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: 1718757122974100001 Content-Type: text/plain; charset="utf-8" Change get_doc_indented() to preserve indentation on all subsequent text lines, and create a compatibility dedent() function for qapidoc.py to remove that indentation. This is being done for the benefit of a new qapidoc generator which requires that indentation in argument and features sections are preserved. Prior to this patch, a section like this: ``` @name: lorem ipsum dolor sit amet consectetur adipiscing elit ``` would have its body text be parsed as: (first and final newline only for presentation) ``` lorem ipsum dolor sit amet consectetur adipiscing elit ``` We want to preserve the indentation for even the first body line so that the entire block can be parsed directly as rST. This patch would now parse that segment as: ``` lorem ipsum dolor sit amet consectetur adipiscing elit ``` This is helpful for formatting arguments and features as field lists in rST, where the new generator will format this information as: ``` :arg type name: lorem ipsum dolor sit amet consectetur apidiscing elit ``` ...and can be formed by the simple concatenation of the field list construct and the body text. The indents help preserve the continuation of a block-level element, and further allow the use of additional rST block-level constructs such as code blocks, lists, and other such markup. Avoiding reflowing the text conditionally also helps preserve source line context for better rST error reporting from sphinx through generated source, too. This understandably breaks the existing qapidoc.py; so a new function is added there to dedent the text for compatibility. Once the new generator is merged, this function will not be needed any longer and can be dropped. I verified this patch changes absolutely nothing by comparing the md5sums of the QMP ref html pages both before and after the change, so it's certified inert. QAPI test output has been updated to reflect the new strategy of preserving indents for rST. before: 69cde3d6f18b0f324badbb447d4381ce manual_before/interop/qemu-ga-ref.html 446e9381833def2adc779f1b90f2215f manual_before/interop/qemu-qmp-ref.html df0ad6c26cb4c28b85d663fe44609c12 manual_before/interop/qemu-storage-daemon= -qmp-ref.html after: 69cde3d6f18b0f324badbb447d4381ce manual/interop/qemu-ga-ref.html 446e9381833def2adc779f1b90f2215f manual/interop/qemu-qmp-ref.html df0ad6c26cb4c28b85d663fe44609c12 manual/interop/qemu-storage-daemon-qmp-re= f.html Signed-off-by: John Snow Reviewed-by: Markus Armbruster --- docs/sphinx/qapidoc.py | 29 ++++++++++++++++++++++++----- scripts/qapi/parser.py | 5 +++-- tests/qapi-schema/doc-good.out | 32 ++++++++++++++++---------------- 3 files changed, 43 insertions(+), 23 deletions(-) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index e675966defa..f2f2005dd5f 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -26,6 +26,7 @@ =20 import os import re +import textwrap =20 from docutils import nodes from docutils.parsers.rst import Directive, directives @@ -53,6 +54,21 @@ __version__ =3D "1.0" =20 =20 +def dedent(text: str) -> str: + # Temporary: In service of the new QAPI Sphinx domain, the QAPI doc + # parser now preserves indents in args/members/features text. + # QAPIDoc does not handle this well, so undo that change here. + + lines =3D text.splitlines(True) + if re.match(r"\s+", lines[0]): + # First line is indented; description started on the line after + # the name. dedent the whole block. + return textwrap.dedent(text) + + # Descr started on same line. Dedent line 2+. + return lines[0] + textwrap.dedent("".join(lines[1:])) + + # Disable black auto-formatter until re-enabled: # fmt: off =20 @@ -176,7 +192,7 @@ def _nodes_for_members(self, doc, what, base=3DNone, br= anches=3DNone): term =3D self._nodes_for_one_member(section.member) # TODO drop fallbacks when undocumented members are outlawed if section.text: - defn =3D section.text + defn =3D dedent(section.text) else: defn =3D [nodes.Text('Not documented')] =20 @@ -214,7 +230,7 @@ def _nodes_for_enum_values(self, doc): termtext.extend(self._nodes_for_ifcond(section.member.ifco= nd)) # TODO drop fallbacks when undocumented members are outlawed if section.text: - defn =3D section.text + defn =3D dedent(section.text) else: defn =3D [nodes.Text('Not documented')] =20 @@ -249,7 +265,7 @@ def _nodes_for_features(self, doc): dlnode =3D nodes.definition_list() for section in doc.features.values(): dlnode +=3D self._make_dlitem( - [nodes.literal('', section.member.name)], section.text) + [nodes.literal('', section.member.name)], dedent(section.t= ext)) seen_item =3D True =20 if not seen_item: @@ -272,9 +288,12 @@ def _nodes_for_sections(self, doc): continue snode =3D self._make_section(section.tag) if section.tag and section.tag.startswith('Example'): - snode +=3D self._nodes_for_example(section.text) + snode +=3D self._nodes_for_example(dedent(section.text)) else: - self._parse_text_into_node(section.text, snode) + self._parse_text_into_node( + dedent(section.text) if section.tag else section.text, + snode, + ) nodelist.append(snode) return nodelist =20 diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 7b13a583ac1..43167ef0ab3 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -437,6 +437,7 @@ def _match_at_name_colon(string: str) -> Optional[Match= [str]]: return re.match(r'@([^:]*): *', string) =20 def get_doc_indented(self, doc: 'QAPIDoc') -> Optional[str]: + """get_doc_indented preserves indentation for later rST parsing.""" self.accept(False) line =3D self.get_doc_line() while line =3D=3D '': @@ -448,7 +449,7 @@ def get_doc_indented(self, doc: 'QAPIDoc') -> Optional[= str]: indent =3D must_match(r'\s*', line).end() if not indent: return line - doc.append_line(line[indent:]) + doc.append_line(line) prev_line_blank =3D False while True: self.accept(False) @@ -465,7 +466,7 @@ def get_doc_indented(self, doc: 'QAPIDoc') -> Optional[= str]: self, "unexpected de-indent (expected at least %d spaces)" % indent) - doc.append_line(line[indent:]) + doc.append_line(line) prev_line_blank =3D True =20 def get_doc_paragraph(self, doc: 'QAPIDoc') -> Optional[str]: diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 716a9a41026..435f6e6d768 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -117,8 +117,8 @@ doc symbol=3DBase body=3D =20 arg=3Dbase1 -description starts on a new line, -minimally indented + description starts on a new line, + minimally indented doc symbol=3DVariant1 body=3D A paragraph @@ -145,8 +145,8 @@ doc symbol=3DAlternate =20 arg=3Di description starts on the same line -remainder indented the same -@b is undocumented + remainder indented the same + @b is undocumented arg=3Db =20 feature=3Dalt-feat @@ -158,11 +158,11 @@ doc symbol=3Dcmd body=3D =20 arg=3Darg1 -description starts on a new line, -indented + description starts on a new line, + indented arg=3Darg2 description starts on the same line -remainder indented differently + remainder indented differently arg=3Darg3 =20 feature=3Dcmd-feat1 @@ -178,16 +178,16 @@ some section=3DTODO frobnicate section=3DNotes -- Lorem ipsum dolor sit amet -- Ut enim ad minim veniam + - Lorem ipsum dolor sit amet + - Ut enim ad minim veniam =20 -Duis aute irure dolor + Duis aute irure dolor section=3DExample --> in -<- out + -> in + <- out section=3DExamples -- *verbatim* -- {braces} + - *verbatim* + - {braces} section=3DSince 2.10 doc symbol=3Dcmd-boxed @@ -198,9 +198,9 @@ a feature feature=3Dcmd-feat2 another feature section=3DExample --> in + -> in =20 -<- out + <- out doc symbol=3DEVT_BOXED body=3D =20 --=20 2.44.0