From nobody Wed Feb 11 01:26:03 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@gnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@gnu.org Return-Path: Received: from lists.gnu.org (208.118.235.17 [208.118.235.17]) by mx.zohomail.com with SMTPS id 1506958254839225.43637324688325; Mon, 2 Oct 2017 08:30:54 -0700 (PDT) Received: from localhost ([::1]:52840 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dz2g7-0003Ek-W8 for importer@patchew.org; Mon, 02 Oct 2017 11:30:44 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:38633) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dz2bZ-0007x1-EW for qemu-devel@nongnu.org; Mon, 02 Oct 2017 11:26:03 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dz2bV-0007rM-Te for qemu-devel@nongnu.org; Mon, 02 Oct 2017 11:26:01 -0400 Received: from mx1.redhat.com ([209.132.183.28]:58192) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dz2bV-0007qh-LH for qemu-devel@nongnu.org; Mon, 02 Oct 2017 11:25:57 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id AD321C04AC70; Mon, 2 Oct 2017 15:25:56 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-116-91.ams2.redhat.com [10.36.116.91]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 167BA5D720; Mon, 2 Oct 2017 15:25:54 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 8F1B3115626E; Mon, 2 Oct 2017 17:25:52 +0200 (CEST) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com AD321C04AC70 Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; spf=fail smtp.mailfrom=armbru@redhat.com From: Markus Armbruster To: qemu-devel@nongnu.org Date: Mon, 2 Oct 2017 17:25:24 +0200 Message-Id: <20171002152552.27999-5-armbru@redhat.com> In-Reply-To: <20171002152552.27999-1-armbru@redhat.com> References: <20171002152552.27999-1-armbru@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Mon, 02 Oct 2017 15:25:56 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [RFC PATCH 04/32] qapi2texi: Fix for '@' not followed by \w character X-BeenThere: qemu-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: marcandre.lureau@redhat.com, mdroth@linux.vnet.ibm.com Errors-To: qemu-devel-bounces+importer=patchew.org@gnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Signed-off-by: Markus Armbruster Reviewed-by: Marc-Andr=C3=A9 Lureau --- scripts/qapi2texi.py | 22 ++++++++++++---------- tests/qapi-schema/doc-good.json | 2 +- tests/qapi-schema/doc-good.out | 2 +- tests/qapi-schema/doc-good.texi | 2 +- 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index 1500afc553..cfcd8a19f0 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -41,14 +41,17 @@ def subst_emph(doc): return re.sub(r'\b_([^_\n]+)_\b', r'@emph{\1}', doc) =20 =20 -def subst_vars(doc): - """Replaces @var by @code{var}""" - return re.sub(r'@([\w-]+)', r'@code{\1}', doc) - - -def subst_braces(doc): - """Replaces {} with @{ @}""" - return doc.replace('{', '@{').replace('}', '@}') +def subst_special(doc): + ret =3D '' + for m in re.finditer(r'([^@{}]*)(@([-\w]*)|[{}])?', doc): + ret +=3D m.group(1) + if m.group(3): + # format @NAME as @code{NAME} + ret +=3D '@code{' + m.group(3) + '}' + elif m.group(2): + # escape Texinfo's special characters + ret +=3D '@' + m.group(2) + return ret =20 =20 def texi_example(doc): @@ -71,8 +74,7 @@ def texi_format(doc): - */-: generates an @itemize list """ ret =3D '' - doc =3D subst_braces(doc) - doc =3D subst_vars(doc) + doc =3D subst_special(doc) doc =3D subst_emph(doc) doc =3D subst_strong(doc) inlist =3D '' diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.j= son index 54a0012d5f..274004a8b6 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -10,7 +10,7 @@ # # *strong* _with emphasis_ # @var {in braces} -# lone @ BUG: gets passed to Texinfo unescaped +# lone @ # * List item one # - Two, multiple # lines diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index a62d2d879c..46261d5010 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -38,7 +38,7 @@ doc freeform =20 *strong* _with emphasis_ @var {in braces} -lone @ BUG: gets passed to Texinfo unescaped +lone @ * List item one - Two, multiple lines diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.t= exi index 3b77f2f675..8777cbb7fb 100644 --- a/tests/qapi-schema/doc-good.texi +++ b/tests/qapi-schema/doc-good.texi @@ -4,7 +4,7 @@ =20 @strong{strong} @emph{with emphasis} @code{var} @{in braces@} -lone @ BUG: gets passed to Texinfo unescaped +lone @@ @itemize @bullet @item List item one --=20 2.13.6