{"id":2197679,"url":"http://patchwork.ozlabs.org/api/1.0/patches/2197679/?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":"<260f2d989f4187940e371023dc8a035c28521b8e.1771408406.git.mchehab+huawei@kernel.org>","date":"2026-02-18T10:13:07","name":"[37/38] docs: kdoc_output: describe the class init parameters","commit_ref":null,"pull_url":null,"state":"handled-elsewhere","archived":false,"hash":"36091bd6b31b33357b07339253a4015acfd02018","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/260f2d989f4187940e371023dc8a035c28521b8e.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/2197679/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=Mq/VdpSK;\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 4fGC5n3CKYz1xpl\n\tfor ; Wed, 18 Feb 2026 21:13:49 +1100 (AEDT)","from localhost (localhost [127.0.0.1])\n\tby smtp3.osuosl.org (Postfix) with ESMTP id B34EF60818;\n\tWed, 18 Feb 2026 10:13:45 +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 XAjZRS-OVD-Z; Wed, 18 Feb 2026 10:13:45 +0000 (UTC)","from lists1.osuosl.org (lists1.osuosl.org [140.211.166.142])\n\tby smtp3.osuosl.org (Postfix) with ESMTP id 2DF8D60656;\n\tWed, 18 Feb 2026 10:13:45 +0000 (UTC)","from smtp2.osuosl.org (smtp2.osuosl.org [140.211.166.133])\n by lists1.osuosl.org (Postfix) with ESMTP id 88F9F206\n for ; Wed, 18 Feb 2026 10:13:34 +0000 (UTC)","from localhost (localhost [127.0.0.1])\n by smtp2.osuosl.org (Postfix) with ESMTP id 7ADB540175\n for ; Wed, 18 Feb 2026 10:13:34 +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 TJRP_nN_-UoI for ;\n Wed, 18 Feb 2026 10:13:33 +0000 (UTC)","from sea.source.kernel.org (sea.source.kernel.org [172.234.252.31])\n by smtp2.osuosl.org (Postfix) with ESMTPS id 8DEBE40078\n for ; Wed, 18 Feb 2026 10:13:33 +0000 (UTC)","from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58])\n by sea.source.kernel.org (Postfix) with ESMTP id 5477D44559;\n Wed, 18 Feb 2026 10:13:33 +0000 (UTC)","by smtp.kernel.org (Postfix) with ESMTPSA id 355F5C19423;\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 1vseYl-00000000M3c-1jrv; Wed, 18 Feb 2026 11:13:31 +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 2DF8D60656","OpenDKIM Filter v2.11.0 smtp2.osuosl.org 8DEBE40078"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=osuosl.org;\n\ts=default; t=1771409625;\n\tbh=M2r75xLw6ki6hw5UNSDMhyRUQglSOxJKz5TH7Cvh25s=;\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=Mq/VdpSKRsQncN+tKbKeQcR/lbOQfGBpbG8QmfFmHew3kYk+u4hsoi5QpyFc/eBeB\n\t C6zUQni12iV7GgPgBlzPdP19KjHzcu9koAS6n9GaDn0i4+lsDbuq3X1tCmd4ELmSGJ\n\t N1Nvz9jgFdlGGWBdTQC4TtfRvnF5jdXnoH+duLoTi7esZCV3D96dHS29UnSE8pqjpC\n\t 5xbcwnjJHuHfHA9F2pfCC4UOY/Vky/Wph6gwOsRcbH/sIZzS88BJk8ZYkI2YTUzcME\n\t A8I4nJml5omnUgefUizjp8dPNNOWLdla2hNRiAF6L366q/MBBPKssJzdRPIBCBJRwd\n\t 7GNmDyh/nD6dA==","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 8DEBE40078","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","Date":"Wed, 18 Feb 2026 11:13:07 +0100","Message-ID":"\n <260f2d989f4187940e371023dc8a035c28521b8e.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=3P9hiqMJWs99bANIe05s+PiDHBtg0dmIB/Ud7yaibWo=;\n h=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n b=BIqwfoV+v2/xOuRN3E350Oc1l18+qkwnx9/6fTKNR5zqTbMATC7FyhCuXooCYEFv+\n nuM+zMKR0Dkz76X0z+E27ndHyVP60cR4SY0EnFxlB/tmE9dpC2E6vxiaTrzzNrQCgq\n N/s/PVLmWVtxqkDYYgqml5YXJxERJp9sZnI8wxLeuPkES5tQEw87AGs+ijfiuzH+9d\n 8aY7C5sLaHyfK00lC4HG4/4qB022KabQuKgPsjpyUY+Ph4W2czJRHO+lgACqw0A7oE\n n6rLK0qfM05yTq7X21eGyzrHxkfKv12GCRxxBtH+72jVUmcsleSjOxBtcSALVF/SWd\n 8rjjIjpYU76FQ==","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=BIqwfoV+"],"Subject":"[Intel-wired-lan] [PATCH 37/38] docs: kdoc_output: describe the\n class init parameters","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":"As this class is part of the ABI used by both Sphinx kerneldoc\nextension and docs/tools/kernel-doc, better describe what\nparmeters are used to initialize ManOutput class.\n\nSigned-off-by: Mauro Carvalho Chehab \n---\n tools/lib/python/kdoc/kdoc_output.py | 29 +++++++++++++++++++++++++++-\n 1 file changed, 28 insertions(+), 1 deletion(-)","diff":"diff --git a/tools/lib/python/kdoc/kdoc_output.py b/tools/lib/python/kdoc/kdoc_output.py\nindex fb44cc8e0770..1e3dc47bc696 100644\n--- a/tools/lib/python/kdoc/kdoc_output.py\n+++ b/tools/lib/python/kdoc/kdoc_output.py\n@@ -580,7 +580,34 @@ class RestFormat(OutputFormat):\n \n \n class ManFormat(OutputFormat):\n- \"\"\"Consts and functions used by man pages output.\"\"\"\n+ \"\"\"\n+ Consts and functions used by man pages output.\n+\n+ This class has one mandatory parameter and some optional ones, which\n+ are needed to define the title header contents:\n+\n+ ``modulename``\n+ Defines the module name to be used at the troff ``.TH`` output.\n+\n+ This argument is mandatory.\n+\n+ ``section``\n+ Usually a numeric value from 0 to 9, but man pages also accept\n+ some strings like \"p\".\n+\n+ Defauls to ``9``\n+\n+ ``manual``\n+ Defaults to ``Kernel API Manual``.\n+\n+ The above controls the output of teh corresponding fields on troff\n+ title headers, which will be filled like this::\n+\n+ .TH \"{name}\" {section} \"{date}\" \"{modulename}\" \"{manual}\"\n+\n+ where ``name``` will match the API symbol name, and ``date`` will be\n+ either the date where the Kernel was compiled or the current date\n+ \"\"\"\n \n highlights = (\n (type_constant, r\"\\1\"),\n","prefixes":["37/38"]}