{"id":2197660,"url":"http://patchwork.ozlabs.org/api/1.0/patches/2197660/?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":"<497fbbcd66ab400c323c8840f917a8552fa801f3.1771408406.git.mchehab+huawei@kernel.org>","date":"2026-02-18T10:12:46","name":"[16/38] docs: kdoc_re: better show KernRe() at documentation","commit_ref":null,"pull_url":null,"state":"handled-elsewhere","archived":false,"hash":"c0e1065d3370af2d47e84d2fa10a50d467f7aa7a","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/497fbbcd66ab400c323c8840f917a8552fa801f3.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/2197660/checks/","tags":{},"headers":{"Return-Path":"<intel-wired-lan-bounces@osuosl.org>","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=r6aPSAed;\n\tdkim-atps=neutral","legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=osuosl.org\n (client-ip=2605:bc80:3010::138; helo=smtp1.osuosl.org;\n envelope-from=intel-wired-lan-bounces@osuosl.org;\n receiver=patchwork.ozlabs.org)"],"Received":["from smtp1.osuosl.org (smtp1.osuosl.org [IPv6:2605:bc80:3010::138])\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 4fGC5W30xxz1xpl\n\tfor <incoming@patchwork.ozlabs.org>; Wed, 18 Feb 2026 21:13:35 +1100 (AEDT)","from localhost (localhost [127.0.0.1])\n\tby smtp1.osuosl.org (Postfix) with ESMTP id A0A1D810AD;\n\tWed, 18 Feb 2026 10:13:31 +0000 (UTC)","from smtp1.osuosl.org ([127.0.0.1])\n by localhost (smtp1.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP\n id FaQQsS3PQlQd; Wed, 18 Feb 2026 10:13:31 +0000 (UTC)","from lists1.osuosl.org (lists1.osuosl.org [140.211.166.142])\n\tby smtp1.osuosl.org (Postfix) with ESMTP id 27348810A4;\n\tWed, 18 Feb 2026 10:13:31 +0000 (UTC)","from smtp1.osuosl.org (smtp1.osuosl.org [IPv6:2605:bc80:3010::138])\n by lists1.osuosl.org (Postfix) with ESMTP id 34728438\n for <intel-wired-lan@lists.osuosl.org>; Wed, 18 Feb 2026 10:13:25 +0000 (UTC)","from localhost (localhost [127.0.0.1])\n by smtp1.osuosl.org (Postfix) with ESMTP id 937C281091\n for <intel-wired-lan@lists.osuosl.org>; Wed, 18 Feb 2026 10:13:24 +0000 (UTC)","from smtp1.osuosl.org ([127.0.0.1])\n by localhost (smtp1.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP\n id XLAenB1QhHek for <intel-wired-lan@lists.osuosl.org>;\n Wed, 18 Feb 2026 10:13:24 +0000 (UTC)","from sea.source.kernel.org (sea.source.kernel.org\n [IPv6:2600:3c0a:e001:78e:0:1991:8:25])\n by smtp1.osuosl.org (Postfix) with ESMTPS id 1064D8108B\n for <intel-wired-lan@lists.osuosl.org>; Wed, 18 Feb 2026 10:13:23 +0000 (UTC)","from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58])\n by sea.source.kernel.org (Postfix) with ESMTP id CAA0E44562;\n Wed, 18 Feb 2026 10:13:23 +0000 (UTC)","by smtp.kernel.org (Postfix) with ESMTPSA id AB684C2BC86;\n Wed, 18 Feb 2026 10:13:23 +0000 (UTC)","from mchehab by mail.kernel.org with local (Exim 4.99.1)\n (envelope-from <mchehab+huawei@kernel.org>)\n id 1vseYb-00000000LdF-46Fo; Wed, 18 Feb 2026 11:13:21 +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=<UNKNOWN> ","DKIM-Filter":["OpenDKIM Filter v2.11.0 smtp1.osuosl.org 27348810A4","OpenDKIM Filter v2.11.0 smtp1.osuosl.org 1064D8108B"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=osuosl.org;\n\ts=default; t=1771409611;\n\tbh=Ci2P0snVWG6yqqUvHKCgueJDIFrv4s9ClHU5R3mYXT8=;\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=r6aPSAedAYF2TBMt0+HCsz81FufWtNEW2GiqLF21rW4yyPwPJ1+idCS0cLHzdo5Wd\n\t W2edJVMrk/7SxMIQIC844psIO5I1PLXnz5usCXlSVwYZlQDcPWuX6qXpJ1D20iErWI\n\t gUqk2P1SvPm5hlRcKHgdDkwFZz3PPGFjYL5n+exbE06/qWlBOQr3bgVDHQLiWzMcwe\n\t Z8b5LBLgGT1TqknEhWgnvwHmtfi+DLI0p4hO2Hh1vUxVsbXnFIVBNrSp7WW/rZ02qJ\n\t qfd4rJgf1kuHVV+Z8IjysIHlnoAeW/KRoCkqv0DPOPR83ubJ7P3qU5J3JLuhI6GGDs\n\t q5mEEajhFncmw==","Received-SPF":"Pass (mailfrom) identity=mailfrom;\n client-ip=2600:3c0a:e001:78e:0:1991:8:25; helo=sea.source.kernel.org;\n envelope-from=mchehab+huawei@kernel.org; receiver=<UNKNOWN>","DMARC-Filter":"OpenDMARC Filter v1.4.2 smtp1.osuosl.org 1064D8108B","From":"Mauro Carvalho Chehab <mchehab+huawei@kernel.org>","To":"Jonathan Corbet <corbet@lwn.net>,\n Linux Doc Mailing List <linux-doc@vger.kernel.org>","Cc":"Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,\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 <aleksandr.loktionov@intel.com>,\n Randy Dunlap <rdunlap@infradead.org>","Date":"Wed, 18 Feb 2026 11:12:46 +0100","Message-ID":"\n <497fbbcd66ab400c323c8840f917a8552fa801f3.1771408406.git.mchehab+huawei@kernel.org>","X-Mailer":"git-send-email 2.52.0","In-Reply-To":"<cover.1771408406.git.mchehab+huawei@kernel.org>","References":"<cover.1771408406.git.mchehab+huawei@kernel.org>","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=1771409603;\n bh=KU0YswEvwG2VkW3AG45CjZ2okRV/mwbS3lMGf4DpG8U=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n b=AjCHRstYcLRm3u4c4fawaisKaLhZHmBhWg1udI9djeLJzP+35BeRm04ViNsvVOyD0\n 70qhKifzCF6HrgWSr4hOtipPfZCZaNRUU7aqN1IncQgLe+2n/Tw3X+SD3urp81/ePC\n YPgVS8R1DVFQh3bvniBmgDDJhr3Nvw/IWOgTEbgf1vRfmgd3c20bSQej5CgOJVUU2e\n iQF4d1sN+7KFL3RjyHWrn6Xx3QxAJkvJOGhHnG6vTd0kgQZFpB0CRavnDHQOy6PVtm\n zCfrnRzDgiIQRXoZeRCysOMYeNVQPwGsZ7pMzX/mRSvdXRUcUo11ZVxiWa+FtsfkAl\n z3Iqswua2f2vA==","X-Mailman-Original-Authentication-Results":["smtp1.osuosl.org;\n dmarc=pass (p=quarantine dis=none)\n header.from=kernel.org","smtp1.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=AjCHRstY"],"Subject":"[Intel-wired-lan] [PATCH 16/38] docs: kdoc_re: better show KernRe()\n at documentation","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 <intel-wired-lan.osuosl.org>","List-Unsubscribe":"<https://lists.osuosl.org/mailman/options/intel-wired-lan>,\n <mailto:intel-wired-lan-request@osuosl.org?subject=unsubscribe>","List-Archive":"<http://lists.osuosl.org/pipermail/intel-wired-lan/>","List-Post":"<mailto:intel-wired-lan@osuosl.org>","List-Help":"<mailto:intel-wired-lan-request@osuosl.org?subject=help>","List-Subscribe":"<https://lists.osuosl.org/mailman/listinfo/intel-wired-lan>,\n <mailto:intel-wired-lan-request@osuosl.org?subject=subscribe>","Errors-To":"intel-wired-lan-bounces@osuosl.org","Sender":"\"Intel-wired-lan\" <intel-wired-lan-bounces@osuosl.org>"},"content":"the __repr__() function is used by autodoc to document macro\ninitialization.\n\nAdd a better representation for them.\n\nSigned-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>\nReviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com>\n---\n tools/lib/python/kdoc/kdoc_re.py | 23 ++++++++++++++++++++++-\n 1 file changed, 22 insertions(+), 1 deletion(-)","diff":"diff --git a/tools/lib/python/kdoc/kdoc_re.py b/tools/lib/python/kdoc/kdoc_re.py\nindex 420cb8879ba3..0a7f12616f9f 100644\n--- a/tools/lib/python/kdoc/kdoc_re.py\n+++ b/tools/lib/python/kdoc/kdoc_re.py\n@@ -52,7 +52,28 @@ class KernRe:\n         return self.regex.pattern\n \n     def __repr__(self):\n-        return f're.compile(\"{self.regex.pattern}\")'\n+        \"\"\"\n+        Returns a displayable version of the class init.\n+        \"\"\"\n+\n+        flag_map = {\n+            re.IGNORECASE: \"re.I\",\n+            re.MULTILINE: \"re.M\",\n+            re.DOTALL: \"re.S\",\n+            re.VERBOSE: \"re.X\",\n+        }\n+\n+        flags = []\n+        for flag, name in flag_map.items():\n+            if self.regex.flags & flag:\n+                flags.append(name)\n+\n+        flags_name = \" | \".join(flags)\n+\n+        if flags_name:\n+            return f'KernRe(\"{self.regex.pattern}\", {flags_name})'\n+        else:\n+            return f'KernRe(\"{self.regex.pattern}\")'\n \n     def __add__(self, other):\n         \"\"\"\n","prefixes":["16/38"]}