From nobody Mon Nov 25 01:29:31 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=1719440825; cv=none; d=zohomail.com; s=zohoarc; b=YFf7CmYzbrtpxRJJzULg61vzQJlq/eQefFaqIky0vO0mWl0KApd3Ab436JxWiOXzuVVWsUryYiFHHP426a4dbQaRM3OJYn1oznd9lS9vlmybgNgO2f0lxh/WhPKmwDtfyqQw+WliXCT2IvooMfQFk3VY6TUtXdK2lqXA5T52PbU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1719440825; 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=n5p7l/8qH5RC/KJ9DC6qPOIpLraTEAkYrzDGrZv2Ki8=; b=LXSD7Nfq5tEKhuNfEMiq+zj6+K7qz0x6j/uoaw1gvsergmUhwtLqQxjrhu+LmKDWEjSV4sToIZ2gA+/PDj32x07t5vzQuAz3iLHzdeqDNBnaveaCFmEOqpWVDcxWnkK849mUfuo7guprghASF+BI81WtkHOJYUx1+I0foLCGdEo= 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 171944082544544.638462630093954; Wed, 26 Jun 2024 15:27:05 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sMb2E-0005PV-EV; Wed, 26 Jun 2024 18:22:38 -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 1sMb2C-0005Oy-Q5 for qemu-devel@nongnu.org; Wed, 26 Jun 2024 18:22:36 -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 1sMb2B-0002HT-0E for qemu-devel@nongnu.org; Wed, 26 Jun 2024 18:22:36 -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-442-YIjRjaZaNn6zQotlSqVnjQ-1; Wed, 26 Jun 2024 18:22:30 -0400 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-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 95F76195608A; Wed, 26 Jun 2024 22:22:22 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.8.67]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 7B4E91955F2D; Wed, 26 Jun 2024 22:22:15 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1719440553; 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=n5p7l/8qH5RC/KJ9DC6qPOIpLraTEAkYrzDGrZv2Ki8=; b=eyI+FlTTOx7Cgfv6A66LWam0Lf9MKQfCc8A2aaVHQMgKiRT8iSj7yOM7MIjW20bdke6D/N PFM7jy48+BFFLQZIzkW4UTDLo4ZIVHD5G0ZL6YjjVDbaV8wsqzlIpA7kSnhMrtdecbdjMd 1z4O3Gv/Xv3WeKrdmkOoC+5axjKn6UU= X-MC-Unique: YIjRjaZaNn6zQotlSqVnjQ-1 From: John Snow To: qemu-devel@nongnu.org Cc: Mads Ynddal , Jiri Pirko , Stefan Hajnoczi , Eric Blake , Peter Maydell , Michael Roth , "Michael S. Tsirkin" , Alex Williamson , Pavel Dovgalyuk , Victor Toso de Carvalho , =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , qemu-block@nongnu.org, Ani Sinha , Fabiano Rosas , Marcel Apfelbaum , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Gerd Hoffmann , Paolo Bonzini , Kevin Wolf , Peter Xu , Eduardo Habkost , Markus Armbruster , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Lukas Straub , Igor Mammedov , Jason Wang , Yanan Wang , Hanna Reitz , Konstantin Kostiuk , Stefan Berger , John Snow Subject: [PATCH v2 05/21] qapi/parser: preserve indentation in QAPIDoc sections Date: Wed, 26 Jun 2024 18:21:11 -0400 Message-ID: <20240626222128.406106-6-jsnow@redhat.com> In-Reply-To: <20240626222128.406106-1-jsnow@redhat.com> References: <20240626222128.406106-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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: -22 X-Spam_score: -2.3 X-Spam_bar: -- X-Spam_report: (-2.3 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.207, 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, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=unavailable 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: 1719440826001100001 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 that removes indentation the same way get_doc_indented() did. 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 into: ``` 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 into: ``` 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. 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. Signed-off-by: John Snow [Edited commit message and code comments per review --js] Reviewed-by: Markus Armbruster --- docs/sphinx/qapidoc.py | 27 ++++++++++++++++++++++----- scripts/qapi/parser.py | 4 ++-- tests/qapi-schema/doc-good.out | 32 ++++++++++++++++---------------- 3 files changed, 40 insertions(+), 23 deletions(-) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index 659e507353a..f9683444b14 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,19 @@ __version__ =3D "1.0" =20 =20 +def dedent(text: str) -> str: + # Adjust indentation to make description text parse as paragraph. + + 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 @@ -164,7 +178,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 @@ -202,7 +216,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 @@ -237,7 +251,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: @@ -260,9 +274,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..1ef1f85b028 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -448,7 +448,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 +465,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.45.0