{"id":2197683,"url":"http://patchwork.ozlabs.org/api/1.0/patches/2197683/?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:01","name":"[31/38] docs: kdoc_re: Fix NestedMatch.sub() which causes PDF builds to break","commit_ref":null,"pull_url":null,"state":"handled-elsewhere","archived":false,"hash":"eeb936c4e95271048c7b4272be0733e838b26ea2","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/f025e8ed3b01e193977b56df128694c1d2aaeb43.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/2197683/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=DnE6Evz9;\n\tdkim-atps=neutral","legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=osuosl.org\n (client-ip=140.211.166.137; helo=smtp4.osuosl.org;\n envelope-from=intel-wired-lan-bounces@osuosl.org;\n receiver=patchwork.ozlabs.org)"],"Received":["from smtp4.osuosl.org (smtp4.osuosl.org [140.211.166.137])\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 4fGC5s05w6z1xwr\n\tfor ; Wed, 18 Feb 2026 21:13:53 +1100 (AEDT)","from localhost (localhost [127.0.0.1])\n\tby smtp4.osuosl.org (Postfix) with ESMTP id 68A46407CA;\n\tWed, 18 Feb 2026 10:13:43 +0000 (UTC)","from smtp4.osuosl.org ([127.0.0.1])\n by localhost (smtp4.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP\n id p3miM6IuOQK4; Wed, 18 Feb 2026 10:13:42 +0000 (UTC)","from lists1.osuosl.org (lists1.osuosl.org [140.211.166.142])\n\tby smtp4.osuosl.org (Postfix) with ESMTP id A3E19407FF;\n\tWed, 18 Feb 2026 10:13:42 +0000 (UTC)","from smtp4.osuosl.org (smtp4.osuosl.org [140.211.166.137])\n by lists1.osuosl.org (Postfix) with ESMTP id 11771206\n for ; Wed, 18 Feb 2026 10:13:33 +0000 (UTC)","from localhost (localhost [127.0.0.1])\n by smtp4.osuosl.org (Postfix) with ESMTP id D1986407CF\n for ; Wed, 18 Feb 2026 10:13:32 +0000 (UTC)","from smtp4.osuosl.org ([127.0.0.1])\n by localhost (smtp4.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP\n id 2ZIqGfA98BvU for ;\n Wed, 18 Feb 2026 10:13:32 +0000 (UTC)","from tor.source.kernel.org (tor.source.kernel.org\n [IPv6:2600:3c04:e001:324:0:1991:8:25])\n by smtp4.osuosl.org (Postfix) with ESMTPS id CD92A407F7\n for ; Wed, 18 Feb 2026 10:13:31 +0000 (UTC)","from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58])\n by tor.source.kernel.org (Postfix) with ESMTP id EA85561860;\n Wed, 18 Feb 2026 10:13:30 +0000 (UTC)","by smtp.kernel.org (Postfix) with ESMTPSA id 9EE58C19423;\n Wed, 18 Feb 2026 10:13:30 +0000 (UTC)","from mchehab by mail.kernel.org with local (Exim 4.99.1)\n (envelope-from )\n id 1vseYi-00000000Lw8-3n8u; Wed, 18 Feb 2026 11:13:28 +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 smtp4.osuosl.org A3E19407FF","OpenDKIM Filter v2.11.0 smtp4.osuosl.org CD92A407F7"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=osuosl.org;\n\ts=default; t=1771409622;\n\tbh=BEMSZ9lQgPUKWeolbpNQdJbrsN9Jg7kLj7WVjG76fq4=;\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=DnE6Evz9SLE/2HtoecnSwyI6p5JY2Qrew/3NIoGkK5cQjoaDgrtoXsHX3cq4Sg8Hb\n\t aGnkHWsIv+GiXb+dEGy6THLV0anYmVC7tWkCN2n0PoFivuNUX9FiNrsr+3gU+ey3Cn\n\t AdqB9T00eajPYEFt2Uaoglosn9TdI8CqoWPPEEmA3Fc+mj/YrYT04Eq4A0Mqrhyvoi\n\t HkXIKXKUlLp1v+5dDwM7TnLbqVTVcfrpTeV/L6OZCk/BzBb9pDm9JNdYCqGo+LOvx6\n\t NIzev63tMVNpRdqZ5VQYPaCQmIkVu0FKQERbDPSwjw/ErQ2Cnoln5Hjt6AbnNCPFlc\n\t xg2gSUhad34Aw==","Received-SPF":"Pass (mailfrom) identity=mailfrom;\n client-ip=2600:3c04:e001:324:0:1991:8:25; helo=tor.source.kernel.org;\n envelope-from=mchehab+huawei@kernel.org; receiver=","DMARC-Filter":"OpenDMARC Filter v1.4.2 smtp4.osuosl.org CD92A407F7","From":"Mauro Carvalho Chehab ","To":"Jonathan Corbet ,\n Linux Doc Mailing List ","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 Aleksandr Loktionov ,\n Randy Dunlap , Akira Yokosawa ","Date":"Wed, 18 Feb 2026 11:13:01 +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=1771409610;\n bh=vr6braZddKgoYGrWnqS65Mye11jx/ixo713d+HFrhJc=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n b=TWlB+dWvLoWppC8mBA0qmB5c3nDT2/AmirhXcP6cEGn2a7M25H9Gv7RhoYoSCVB5f\n 9rfe/g4ukmPFLVwz/QyYY/GZ8bChfo+tUv+oMVDLbOYDgP99PE70F8qLv1hDc1TDZ7\n UzJnBBUTlZKsT7YiTlypFluMvPTfRLnhoSQhWUpVu35+hhLeBmEgIrxU2Sxb/TcPSv\n oxoqwpEeQSK11Hg4ko+Nedd+HTPVu8NbsPMzVMinYu8c3vSYxCK7+qctBqB0vjOxRl\n 314TDJCd6Rg9mvBwpfnMK5BBtOCdXMohntcGgJYwXhBp83SuKHjVkldBduyq6KIOYQ\n Nv++eFu1SYyJA==","X-Mailman-Original-Authentication-Results":["smtp4.osuosl.org;\n dmarc=pass (p=quarantine dis=none)\n header.from=kernel.org","smtp4.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=TWlB+dWv"],"Subject":"[Intel-wired-lan] [PATCH 31/38] docs: kdoc_re: Fix\n NestedMatch.sub() which causes PDF builds to break","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":"Having a \"\\digit\" inside a docstring with normal strings causes\nPDF output to break, as it will add a weird character inside the\nstring. It should be using a raw string instead.\n\nYet, having r\"\\0\" won't solve, as this would be converted in\nSphinx as \"0\". So, this has to be inside a pre formatted text.\n\nThat's said, the comment itself is probably not the best one.\n\nRewrite the entire comment to properly document each parameter\nand add a \"delim\" parameter that will be passed to the\nancillary function.\n\nReported-by: Akira Yokosawa \nCloses: https://lore.kernel.org/linux-doc/63e99049-cc72-4156-83af-414fdde34312@gmail.com/\nSigned-off-by: Mauro Carvalho Chehab \n---\n tools/lib/python/kdoc/kdoc_re.py | 30 ++++++++++++++++++------------\n 1 file changed, 18 insertions(+), 12 deletions(-)","diff":"diff --git a/tools/lib/python/kdoc/kdoc_re.py b/tools/lib/python/kdoc/kdoc_re.py\nindex 44af43aa1e93..f67ebe86c458 100644\n--- a/tools/lib/python/kdoc/kdoc_re.py\n+++ b/tools/lib/python/kdoc/kdoc_re.py\n@@ -323,22 +323,28 @@ class NestedMatch:\n \n return args\n \n- def sub(self, sub, line, count=0):\n- \"\"\"\n- This is similar to re.sub:\n+ def sub(self, sub, line, delim=\",\", count=0):\n+ r\"\"\"\n+ Perform a regex‑based replacement on ``line`` for all matches with\n+ the ``self.regex`` pattern. It uses the following parameters:\n \n- It matches a regex that it is followed by a delimiter,\n- replacing occurrences only if all delimiters are paired.\n+ ``sub``\n+ Replacement string that may contain placeholders in the form\n+ ``\\{digit}``, where ``digit`` is an integer referring to the regex\n+ capture group number.\n \n- if the sub argument contains::\n+ ``\\{0}`` is a special case that expands to the entire matched text.\n \n- r'\\0'\n+ ``line``\n+ The string to operate on.\n \n- it will work just like re: it places there the matched paired data\n- with the delimiter stripped.\n+ ``delim``\n+ The delimiter used by identify the placeholder groups\n+ (defaults to \",\").\n \n- If count is different than zero, it will replace at most count\n- items.\n+ ``count``\n+ Maximum number of replacements per match. If 0 or omitted,\n+ all matches are replaced.\n \"\"\"\n out = \"\"\n \n@@ -358,7 +364,7 @@ class NestedMatch:\n # replace arguments\n new_sub = sub\n if \"\\\\\" in sub:\n- args = self._split_args(value)\n+ args = self._split_args(value, delim=delim)\n \n new_sub = re.sub(r'\\\\(\\d+)',\n lambda m: args[int(m.group(1))], new_sub)\n","prefixes":["31/38"]}