{"id":2197677,"url":"http://patchwork.ozlabs.org/api/1.0/patches/2197677/?format=json","project":{"id":46,"url":"http://patchwork.ozlabs.org/api/1.0/projects/46/?format=json","name":"Intel Wired Ethernet development","link_name":"intel-wired-lan","list_id":"intel-wired-lan.osuosl.org","list_email":"intel-wired-lan@osuosl.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"","date":"2026-02-18T10:13:04","name":"[34/38] docs: sphinx-build-wrapper: better handle troff .TH markups","commit_ref":null,"pull_url":null,"state":"handled-elsewhere","archived":false,"hash":"68a0c36bc0b86be16f63d7b416f8cf5c0bc8060e","submitter":{"id":78235,"url":"http://patchwork.ozlabs.org/api/1.0/people/78235/?format=json","name":"Mauro Carvalho Chehab","email":"mchehab+huawei@kernel.org"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/intel-wired-lan/patch/dd1fa03ab5432016a3b05fb1e40dca57485d3a4d.1771408406.git.mchehab+huawei@kernel.org/mbox/","series":[{"id":492532,"url":"http://patchwork.ozlabs.org/api/1.0/series/492532/?format=json","date":"2026-02-18T10:12:30","name":"docs: several improvements to kernel-doc","version":1,"mbox":"http://patchwork.ozlabs.org/series/492532/mbox/"}],"check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/2197677/checks/","tags":{},"headers":{"Return-Path":"","X-Original-To":["incoming@patchwork.ozlabs.org","intel-wired-lan@lists.osuosl.org"],"Delivered-To":["patchwork-incoming@legolas.ozlabs.org","intel-wired-lan@lists.osuosl.org"],"Authentication-Results":["legolas.ozlabs.org;\n\tdkim=pass (2048-bit key;\n unprotected) header.d=osuosl.org header.i=@osuosl.org header.a=rsa-sha256\n header.s=default header.b=BuT0XC7d;\n\tdkim-atps=neutral","legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=osuosl.org\n (client-ip=2605:bc80:3010::136; helo=smtp3.osuosl.org;\n envelope-from=intel-wired-lan-bounces@osuosl.org;\n receiver=patchwork.ozlabs.org)"],"Received":["from smtp3.osuosl.org (smtp3.osuosl.org [IPv6:2605:bc80:3010::136])\n\t(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n\t key-exchange x25519 server-signature ECDSA (secp384r1) server-digest SHA384)\n\t(No client certificate requested)\n\tby legolas.ozlabs.org (Postfix) with ESMTPS id 4fGC5l2tmTz1xwr\n\tfor ; Wed, 18 Feb 2026 21:13:47 +1100 (AEDT)","from localhost (localhost [127.0.0.1])\n\tby smtp3.osuosl.org (Postfix) with ESMTP id DA7EF605DC;\n\tWed, 18 Feb 2026 10:13:43 +0000 (UTC)","from smtp3.osuosl.org ([127.0.0.1])\n by localhost (smtp3.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP\n id n6rv4KHgshJf; Wed, 18 Feb 2026 10:13:43 +0000 (UTC)","from lists1.osuosl.org (lists1.osuosl.org [140.211.166.142])\n\tby smtp3.osuosl.org (Postfix) with ESMTP id 5223A6080A;\n\tWed, 18 Feb 2026 10:13:43 +0000 (UTC)","from smtp3.osuosl.org (smtp3.osuosl.org [IPv6:2605:bc80:3010::136])\n by lists1.osuosl.org (Postfix) with ESMTP id 4412C206\n for ; Wed, 18 Feb 2026 10:13:33 +0000 (UTC)","from localhost (localhost [127.0.0.1])\n by smtp3.osuosl.org (Postfix) with ESMTP id 36076607F3\n for ; Wed, 18 Feb 2026 10:13:33 +0000 (UTC)","from smtp3.osuosl.org ([127.0.0.1])\n by localhost (smtp3.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP\n id ff8Ho3qefpWG for ;\n Wed, 18 Feb 2026 10:13:32 +0000 (UTC)","from sea.source.kernel.org (sea.source.kernel.org [172.234.252.31])\n by smtp3.osuosl.org (Postfix) with ESMTPS id 491EE607F2\n for ; Wed, 18 Feb 2026 10:13:32 +0000 (UTC)","from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58])\n by sea.source.kernel.org (Postfix) with ESMTP id 00B654457E;\n Wed, 18 Feb 2026 10:13:32 +0000 (UTC)","by smtp.kernel.org (Postfix) with ESMTPSA id D8102C2BC86;\n Wed, 18 Feb 2026 10:13:31 +0000 (UTC)","from mchehab by mail.kernel.org with local (Exim 4.99.1)\n (envelope-from )\n id 1vseYk-00000000M03-0i2s; Wed, 18 Feb 2026 11:13:30 +0100"],"X-Virus-Scanned":["amavis at osuosl.org","amavis at osuosl.org"],"X-Comment":"SPF check N/A for local connections - client-ip=140.211.166.142;\n helo=lists1.osuosl.org; envelope-from=intel-wired-lan-bounces@osuosl.org;\n receiver= ","DKIM-Filter":["OpenDKIM Filter v2.11.0 smtp3.osuosl.org 5223A6080A","OpenDKIM Filter v2.11.0 smtp3.osuosl.org 491EE607F2"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=osuosl.org;\n\ts=default; t=1771409623;\n\tbh=8PP3Jsp8GxWj96StrT7RUGSqaXln0Jxsg5MUi6NBozw=;\n\th=From:To:Cc:Date:In-Reply-To:References:Subject:List-Id:\n\t List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe:\n\t From;\n\tb=BuT0XC7diYUaDa3MjistUup/hkP7RNEpj4NB9+NPLmJMYXZ4KzgQRm+vRZioUkRPF\n\t DnCGnYWmE0aPI1c8aHY4jNDNFia/R1VkdRLt0pZRTkgXOblnfsYtQaBQp/xIh+iKtP\n\t ZFQnJ/ZN808qqbtHTgqfqMXzP0E1b9hJYZpExTeyOUMqFW5C0nzg4CQFu1whuGXYQy\n\t jVXKmbKuJy0jBMSGkVH2Ha7FHaAf1ZNB8t+lGLK+/s7CHSOCLDuzqm233XYzWFBR3g\n\t XfEi2Yp2qE3z471S+b97zCZFRpeWgPEp3JtRRsJbHP+2S7xQ3gUjIeNASnMV5Zx55f\n\t V7SXJvlDUgTOA==","Received-SPF":"Pass (mailfrom) identity=mailfrom; client-ip=172.234.252.31;\n helo=sea.source.kernel.org; envelope-from=mchehab+huawei@kernel.org;\n receiver=","DMARC-Filter":"OpenDMARC Filter v1.4.2 smtp3.osuosl.org 491EE607F2","From":"Mauro Carvalho Chehab ","To":"Jonathan Corbet ,\n Linux Doc Mailing List ,\n Mauro Carvalho Chehab ","Cc":"Mauro Carvalho Chehab ,\n intel-wired-lan@lists.osuosl.org, linux-hardening@vger.kernel.org,\n linux-kernel@vger.kernel.org, netdev@vger.kernel.org,\n Shuah Khan ","Date":"Wed, 18 Feb 2026 11:13:04 +0100","Message-ID":"\n ","X-Mailer":"git-send-email 2.52.0","In-Reply-To":"","References":"","MIME-Version":"1.0","Content-Type":"text/plain; charset=\"utf-8\"","Content-Transfer-Encoding":"8bit","X-Mailman-Original-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple;\n d=kernel.org; s=k20201202; t=1771409611;\n bh=J9gpBcUhWSmksHEje7HfFrvd/UJKiZjrUhxoxqAfK3o=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n b=HGaRpMROqM8qzVFGoU6huHazI36POCwMiUwUU3rvaf7mizJI7r7BYYXt5NPl0ZIX2\n rl4YDhZo7lFrS/0MQl5Vb+OI8DimUdQo+H9NbpOOb5g8Uqyf7w8U53PBJzcGIw9oWf\n PpncsMHuc134d0WmDE2dFuaWdQr102z+sKsRKrzIo+PlL1sPrzXi2Czv9SLMpIfjAh\n RcYgv06eKI3xJk4qgGaMZIAJ3gjTMn8CY5Zdp53QzvGfzh7d2aCPEqJquICd5nuxzv\n 4GI5MM+TUvoRebTWS8p/m3B7dIEJPRWJOf38Mv+811CCAMloTtZ2C/jc6LHmFMeBfX\n aWLw+TyMJ2kgg==","X-Mailman-Original-Authentication-Results":["smtp3.osuosl.org;\n dmarc=pass (p=quarantine dis=none)\n header.from=kernel.org","smtp3.osuosl.org;\n dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org\n header.a=rsa-sha256 header.s=k20201202 header.b=HGaRpMRO"],"Subject":"[Intel-wired-lan] [PATCH 34/38] docs: sphinx-build-wrapper: better\n handle troff .TH markups","X-BeenThere":"intel-wired-lan@osuosl.org","X-Mailman-Version":"2.1.30","Precedence":"list","List-Id":"Intel Wired Ethernet Linux Kernel Driver Development\n ","List-Unsubscribe":",\n ","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n ","Errors-To":"intel-wired-lan-bounces@osuosl.org","Sender":"\"Intel-wired-lan\" "},"content":"Using a regular expression to match .TH is problematic, as it\ndoesn't handle well quotation marks.\n\nUse shlex instead.\n\nSigned-off-by: Mauro Carvalho Chehab \n---\n tools/docs/sphinx-build-wrapper | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)","diff":"diff --git a/tools/docs/sphinx-build-wrapper b/tools/docs/sphinx-build-wrapper\nindex b7c149dff06b..e6418e22e2ff 100755\n--- a/tools/docs/sphinx-build-wrapper\n+++ b/tools/docs/sphinx-build-wrapper\n@@ -576,7 +576,6 @@ class SphinxBuilder:\n \"\"\"\n \n re_kernel_doc = re.compile(r\"^\\.\\.\\s+kernel-doc::\\s*(\\S+)\")\n- re_man = re.compile(r'^\\.TH \"[^\"]*\" (\\d+) \"([^\"]*)\"')\n \n if docs_dir == src_dir:\n #\n@@ -616,8 +615,7 @@ class SphinxBuilder:\n fp = None\n try:\n for line in result.stdout.split(\"\\n\"):\n- match = re_man.match(line)\n- if not match:\n+ if not line.startswith(\".TH\"):\n if fp:\n fp.write(line + '\\n')\n continue\n@@ -625,7 +623,9 @@ class SphinxBuilder:\n if fp:\n fp.close()\n \n- fname = f\"{output_dir}/{match.group(2)}.{match.group(1)}\"\n+ # Use shlex here, as it handles well parameters with commas\n+ args = shlex.split(line)\n+ fname = f\"{output_dir}/{args[3]}.{args[2]}\"\n \n if self.verbose:\n print(f\"Creating {fname}\")\n","prefixes":["34/38"]}