{"id":2197680,"url":"http://patchwork.ozlabs.org/api/1.0/patches/2197680/?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:00","name":"[30/38] docs: kdoc_files: allows the caller to use a different xforms class","commit_ref":null,"pull_url":null,"state":"handled-elsewhere","archived":false,"hash":"7fc056250b4097af3f8e1391e28f5d8f2e59159b","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/f245479bfa8cd8dc2ad2041a87085dd2ace8c502.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/2197680/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=FbN7moDe;\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 4fGC5p0bNpz1xwr\n\tfor ; Wed, 18 Feb 2026 21:13:50 +1100 (AEDT)","from localhost (localhost [127.0.0.1])\n\tby smtp4.osuosl.org (Postfix) with ESMTP id 6D35140758;\n\tWed, 18 Feb 2026 10:13:42 +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 7Y0SuqWsxj_v; Wed, 18 Feb 2026 10:13:40 +0000 (UTC)","from lists1.osuosl.org (lists1.osuosl.org [140.211.166.142])\n\tby smtp4.osuosl.org (Postfix) with ESMTP id DBA78407FF;\n\tWed, 18 Feb 2026 10:13:40 +0000 (UTC)","from smtp1.osuosl.org (smtp1.osuosl.org [140.211.166.138])\n by lists1.osuosl.org (Postfix) with ESMTP id 15C5135B\n for ; Wed, 18 Feb 2026 10:13:32 +0000 (UTC)","from localhost (localhost [127.0.0.1])\n by smtp1.osuosl.org (Postfix) with ESMTP id F00AD810A5\n for ; Wed, 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 Ihr8q-dEsWdz for ;\n Wed, 18 Feb 2026 10:13:31 +0000 (UTC)","from tor.source.kernel.org (tor.source.kernel.org\n [IPv6:2600:3c04:e001:324:0:1991:8:25])\n by smtp1.osuosl.org (Postfix) with ESMTPS id 4EE0F810A8\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 700476185E;\n Wed, 18 Feb 2026 10:13:30 +0000 (UTC)","by smtp.kernel.org (Postfix) with ESMTPSA id 23843C19423;\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-00000000Lux-1Xmg; 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 DBA78407FF","OpenDKIM Filter v2.11.0 smtp1.osuosl.org 4EE0F810A8"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=osuosl.org;\n\ts=default; t=1771409620;\n\tbh=Ei+GsIaTtGSh4XJ4j6fZc4hERDpknyZYs+o2vOPmRhk=;\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=FbN7moDeV3Sm+ME6Yzkr/ZrArhLOaEht3NVNCRyQxG5GxKpnR7zVEbclp/wR0ji3T\n\t 9TWcQc3s4h8+G46Nb9J+/imuFJojGr5ncvQtkUJ6D4ZKYYzzBqujcvu8JKpn+O4EJu\n\t WaqOZmPf+zMgu2mAggyTu38M7eSPqilCiQYBVeqLbTnPE66EUTo2J9IeTEQajh9MV9\n\t wliBEJG5gtrJOUKGgysW9ixm8yKMqXSSeSIW/SGn0Zua2dQ+wp+bCUZMtkP0u/91Us\n\t f3/d6TSJa0juDdLZJfATS/2C4nv+KH6rPolDKzxovgiH2HEqY1Mcol0Q7Hw5X6u1To\n\t QAWrEkUAOjAiA==","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 smtp1.osuosl.org 4EE0F810A8","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 Randy Dunlap ","Date":"Wed, 18 Feb 2026 11:13:00 +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=3n5zkoFrFUOIWGD8NapCIbtnoFCw7B0BzF+EBvzaUy8=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n b=tcOYv7LYcrZ5Lrw7m9IiFT46WDG8lvQC26H6JL+ld2BPUJ/cRpb+fn46o6dyjvT3z\n fZ36++HlWV8B7DRuYo13mjduPE5fT8nnpO8Rv4MCt6ukJ39Dg+ah/qQ8tKt1Ool9pE\n 3hGfWgGufvONBSABEpw0bdqfPtL4E4y34ZLJMcjtnt7ZIKGQw92gavA/u+Xv+b6qng\n r9OUi0xaTOnNYXzwOI5k5FLzmWbtUL8ZKzpCOco0nDN+Bj3li2TGD1gTX25P+1WSN8\n G+BraAGRnfcSmOEanFQ64tv8eoq/NABA9KyFjwEh8fSy0vvBTNR5DKd4utoDLvLdjg\n KXoPaETHcYK+Q==","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=tcOYv7LY"],"Subject":"[Intel-wired-lan] [PATCH 30/38] docs: kdoc_files: allows the caller\n to use a different xforms class","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":"While the main goal for kernel-doc is to be used inside the Linux\nKernel, other open source projects could benefit for it. That's\ncurrently the case of QEMU, which has a fork, mainly due to two\nreasons:\n\n - they need an extra C function transform rule;\n - they handle the html output a little bit different.\n\nAdd an extra optional argument to make easier for the code to be\nshared, as, with that, QEMU can just create a new derivated class\nthat will contain its specific rulesets, and just copy the\nremaining kernel-doc files as-is.\n\nSigned-off-by: Mauro Carvalho Chehab \n---\n tools/lib/python/kdoc/kdoc_files.py | 9 +++++++--\n 1 file changed, 7 insertions(+), 2 deletions(-)","diff":"diff --git a/tools/lib/python/kdoc/kdoc_files.py b/tools/lib/python/kdoc/kdoc_files.py\nindex 7357c97a4b01..c35e033cf123 100644\n--- a/tools/lib/python/kdoc/kdoc_files.py\n+++ b/tools/lib/python/kdoc/kdoc_files.py\n@@ -118,7 +118,7 @@ class KernelFiles():\n if fname in self.files:\n return\n \n- doc = KernelDoc(self.config, fname, CTransforms)\n+ doc = KernelDoc(self.config, fname, self.xforms)\n export_table, entries = doc.parse_kdoc()\n \n self.export_table[fname] = export_table\n@@ -154,7 +154,7 @@ class KernelFiles():\n \n self.error(f\"Cannot find file {fname}\")\n \n- def __init__(self, verbose=False, out_style=None,\n+ def __init__(self, verbose=False, out_style=None, xforms=None,\n werror=False, wreturn=False, wshort_desc=False,\n wcontents_before_sections=False,\n logger=None):\n@@ -193,6 +193,11 @@ class KernelFiles():\n self.config.wshort_desc = wshort_desc\n self.config.wcontents_before_sections = wcontents_before_sections\n \n+ if xforms:\n+ self.xforms = xforms\n+ else:\n+ self.xforms = CTransforms()\n+\n if not logger:\n self.config.log = logging.getLogger(\"kernel-doc\")\n else:\n","prefixes":["30/38"]}