{"id":2197685,"url":"http://patchwork.ozlabs.org/api/1.0/patches/2197685/?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":"<45159d8100d22567a592a90769a71a5335f0a085.1771408406.git.mchehab+huawei@kernel.org>","date":"2026-02-18T10:13:08","name":"[38/38] docs: kdoc_output: pick a better default for modulename","commit_ref":null,"pull_url":null,"state":"handled-elsewhere","archived":false,"hash":"8ffd0756aa9ed0c173850e8d56380f4a27a04407","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/45159d8100d22567a592a90769a71a5335f0a085.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/2197685/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=aBDj0TTq;\n\tdkim-atps=neutral","legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=osuosl.org\n (client-ip=2605:bc80:3010::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 [IPv6:2605:bc80:3010::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 4fGC5x4kWgz1xpl\n\tfor ; Wed, 18 Feb 2026 21:13:57 +1100 (AEDT)","from localhost (localhost [127.0.0.1])\n\tby smtp4.osuosl.org (Postfix) with ESMTP id ECD6E40753;\n\tWed, 18 Feb 2026 10:13:46 +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 CEonaz0CDjt9; Wed, 18 Feb 2026 10:13:46 +0000 (UTC)","from lists1.osuosl.org (lists1.osuosl.org [140.211.166.142])\n\tby smtp4.osuosl.org (Postfix) with ESMTP id 5595C40805;\n\tWed, 18 Feb 2026 10:13:46 +0000 (UTC)","from smtp2.osuosl.org (smtp2.osuosl.org [IPv6:2605:bc80:3010::133])\n by lists1.osuosl.org (Postfix) with ESMTP id 75B5035B\n for ; Wed, 18 Feb 2026 10:13:35 +0000 (UTC)","from localhost (localhost [127.0.0.1])\n by smtp2.osuosl.org (Postfix) with ESMTP id 5B90040078\n for ; Wed, 18 Feb 2026 10:13:35 +0000 (UTC)","from smtp2.osuosl.org ([127.0.0.1])\n by localhost (smtp2.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP\n id qJglcJd4ij5h for ;\n Wed, 18 Feb 2026 10:13:34 +0000 (UTC)","from sea.source.kernel.org (sea.source.kernel.org [172.234.252.31])\n by smtp2.osuosl.org (Postfix) with ESMTPS id 3A8384009A\n for ; Wed, 18 Feb 2026 10:13:34 +0000 (UTC)","from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58])\n by sea.source.kernel.org (Postfix) with ESMTP id 00EE44459B;\n Wed, 18 Feb 2026 10:13:34 +0000 (UTC)","by smtp.kernel.org (Postfix) with ESMTPSA id D708EC2BC9E;\n Wed, 18 Feb 2026 10:13:33 +0000 (UTC)","from mchehab by mail.kernel.org with local (Exim 4.99.1)\n (envelope-from )\n id 1vseYm-00000000M4p-0GPz; Wed, 18 Feb 2026 11:13:32 +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 5595C40805","OpenDKIM Filter v2.11.0 smtp2.osuosl.org 3A8384009A"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=osuosl.org;\n\ts=default; t=1771409626;\n\tbh=ZhnMdpvdD7eQXxsKozueTcDL2WcNNZQ9NJGZVbIYRwI=;\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=aBDj0TTqzNcMuK6V6Ho4gc3TzpTtBl60UkH+fsKxmiX2DJSKWlwGq/r2Qt3Y8dc6H\n\t B3NlXy3oPTB/Ho7M+KDFHVGEF206B1S8F62QuW1MEaGy5nd8nGGJdpL06Xc5BDiqSr\n\t 0VcRBPL39QGUKoxRmRWD7ZL2WiNnrJBRZsDR57FZurgpdIzpRPO0rpOcLMUdWcGwjD\n\t Iiaoh9TvejFoCJV+JL7uuaqBZUt5gzKO9IQy5VtQgpPWj2TqsKwlcjrNmFMvkVfn4a\n\t aCsUFZLFr/u1DVgrwh5xlHh6yAVQcLysKLFz1sCbQRaNdpRj8y4KI1hIwSFwcGsy4x\n\t 3c8zCOMRtixHQ==","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 smtp2.osuosl.org 3A8384009A","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:08 +0100","Message-ID":"\n <45159d8100d22567a592a90769a71a5335f0a085.1771408406.git.mchehab+huawei@kernel.org>","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=1771409613;\n bh=fvMjJpvYeiR5dsEmac23+IArGmOBOLOmIiyyzQVBvqE=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n b=XCXs+vDn55NbKpqXTFsPi7CJOEdjC9jxLinK6EHOS/f1g9uf/z3PDR5iM8HgJvv2N\n mw6006xk6eMPrrhZWZ3gUeQXlVDshIklV6mSZyA2lgJ13YDwgHo2gn2K8nzXG/bpJP\n n39uFySI2zwLYiZOkjEYdwgNtOW2LtrKhR7rgIWrEZRbzr7rC8K23c/KG2zdDUwpV5\n UOBj0eJUJmFgIO08ARmNG+Siz2Z6OmI5KuPjSBDbx9dowDPlrvTK01Sir9ICF4Ut/c\n aEvWGuUJcbwKyygGrOWVxR2JEgz6iA8qCHMFu5BmbAekRIl1Bf2Y2UDdWBfrOFHzN+\n 45IuDdYQRZx+A==","X-Mailman-Original-Authentication-Results":["smtp2.osuosl.org;\n dmarc=pass (p=quarantine dis=none)\n header.from=kernel.org","smtp2.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=XCXs+vDn"],"Subject":"[Intel-wired-lan] [PATCH 38/38] docs: kdoc_output: pick a better\n default for modulename","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":"Instead of placing the same data for modulename for all generated\nman pages, use the directory from the filename used to produce\nkernel docs as basis.\n\nSigned-off-by: Mauro Carvalho Chehab \n---\n tools/docs/kernel-doc | 1 -\n tools/lib/python/kdoc/kdoc_output.py | 41 +++++++++++++++++-----------\n 2 files changed, 25 insertions(+), 17 deletions(-)","diff":"diff --git a/tools/docs/kernel-doc b/tools/docs/kernel-doc\nindex aed09f9a54dd..3a932f95bdf5 100755\n--- a/tools/docs/kernel-doc\n+++ b/tools/docs/kernel-doc\n@@ -210,7 +210,6 @@ def main():\n help=\"Enable debug messages\")\n \n parser.add_argument(\"-M\", \"-modulename\", \"--modulename\",\n- default=\"Kernel API\",\n help=\"Allow setting a module name at the output.\")\n \n parser.add_argument(\"-l\", \"-enable-lineno\", \"--enable_lineno\",\ndiff --git a/tools/lib/python/kdoc/kdoc_output.py b/tools/lib/python/kdoc/kdoc_output.py\nindex 1e3dc47bc696..44e40a6e8ca6 100644\n--- a/tools/lib/python/kdoc/kdoc_output.py\n+++ b/tools/lib/python/kdoc/kdoc_output.py\n@@ -589,7 +589,8 @@ class ManFormat(OutputFormat):\n ``modulename``\n Defines the module name to be used at the troff ``.TH`` output.\n \n- This argument is mandatory.\n+ This argument is optional. If not specified, it will be filled\n+ with the directory which contains the documented file.\n \n ``section``\n Usually a numeric value from 0 to 9, but man pages also accept\n@@ -634,14 +635,21 @@ class ManFormat(OutputFormat):\n \"%m %d %Y\",\n ]\n \n- def emit_th(self, name):\n+ def emit_th(self, name, args):\n \"\"\"Emit a title header line.\"\"\"\n- name = name.strip()\n+ title = name.strip()\n+ module = self.modulename(args)\n \n- self.data += f'.TH \"{name}\" {self.section} \"{self.date}\" '\n- self.data += f' \"{self.modulename}\" \"{self.manual}\"\\n'\n+ self.data += f'.TH \"{title}\" {self.section} \"{self.date}\" '\n+ self.data += f' \"{module}\" \"{self.manual}\"\\n'\n \n- def __init__(self, modulename, section=\"9\", manual=\"Kernel API Manual\"):\n+ def modulename(self, args):\n+ if self._modulename:\n+ return self._modulename\n+\n+ return os.path.dirname(args.fname)\n+\n+ def __init__(self, modulename=None, section=\"9\", manual=\"Kernel API Manual\"):\n \"\"\"\n Creates class variables.\n \n@@ -651,7 +659,7 @@ class ManFormat(OutputFormat):\n \n super().__init__()\n \n- self.modulename = modulename\n+ self._modulename = modulename\n self.section = section\n self.manual = manual\n \n@@ -685,7 +693,8 @@ class ManFormat(OutputFormat):\n dtype = args.type\n \n if dtype == \"doc\":\n- return self.modulename\n+ return name\n+# return os.path.basename(self.modulename(args))\n \n if dtype in [\"function\", \"typedef\"]:\n return name\n@@ -762,7 +771,7 @@ class ManFormat(OutputFormat):\n \n out_name = self.arg_name(args, name)\n \n- self.emit_th(out_name)\n+ self.emit_th(out_name, args)\n \n for section, text in args.sections.items():\n self.data += f'.SH \"{section}\"' + \"\\n\"\n@@ -772,7 +781,7 @@ class ManFormat(OutputFormat):\n \n out_name = self.arg_name(args, name)\n \n- self.emit_th(out_name)\n+ self.emit_th(out_name, args)\n \n self.data += \".SH NAME\\n\"\n self.data += f\"{name} \\\\- {args['purpose']}\\n\"\n@@ -818,7 +827,7 @@ class ManFormat(OutputFormat):\n def out_enum(self, fname, name, args):\n out_name = self.arg_name(args, name)\n \n- self.emit_th(out_name)\n+ self.emit_th(out_name, args)\n \n self.data += \".SH NAME\\n\"\n self.data += f\"enum {name} \\\\- {args['purpose']}\\n\"\n@@ -851,7 +860,7 @@ class ManFormat(OutputFormat):\n out_name = self.arg_name(args, name)\n full_proto = args.other_stuff[\"full_proto\"]\n \n- self.emit_th(out_name)\n+ self.emit_th(out_name, args)\n \n self.data += \".SH NAME\\n\"\n self.data += f\"{name} \\\\- {args['purpose']}\\n\"\n@@ -868,11 +877,11 @@ class ManFormat(OutputFormat):\n self.output_highlight(text)\n \n def out_typedef(self, fname, name, args):\n- module = self.modulename\n+ module = self.modulename(args)\n purpose = args.get('purpose')\n out_name = self.arg_name(args, name)\n \n- self.emit_th(out_name)\n+ self.emit_th(out_name, args)\n \n self.data += \".SH NAME\\n\"\n self.data += f\"typedef {name} \\\\- {purpose}\\n\"\n@@ -882,12 +891,12 @@ class ManFormat(OutputFormat):\n self.output_highlight(text)\n \n def out_struct(self, fname, name, args):\n- module = self.modulename\n+ module = self.modulename(args)\n purpose = args.get('purpose')\n definition = args.get('definition')\n out_name = self.arg_name(args, name)\n \n- self.emit_th(out_name)\n+ self.emit_th(out_name, args)\n \n self.data += \".SH NAME\\n\"\n self.data += f\"{args.type} {name} \\\\- {purpose}\\n\"\n","prefixes":["38/38"]}