From: Randy Dunlap <rdunlap@infradead.org>
To: Jakub Kicinski <kuba@kernel.org>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: linux-doc@vger.kernel.org
Subject: Re: kernel-doc no longer warns about leftover argument doc?
Date: Thu, 14 May 2026 18:58:07 -0700 [thread overview]
Message-ID: <1ff1d237-fd32-4373-aaef-d19743bb2ea4@infradead.org> (raw)
In-Reply-To: <20260514184948.3fa705e1@kernel.org>
On 5/14/26 6:49 PM, Jakub Kicinski wrote:
> Hi!
>
> Looks like the new python kernel-doc does not warn when there are
> stray arguments in function kdoc. Eg
>
> /**
> * ksz_wol_pre_shutdown - Prepares the switch device for shutdown while
> * considering Wake-on-LAN (WoL) settings.
> * @dev: The switch device structure.
> * @wol_enabled: Pointer to a boolean which will be set to true if WoL is
> * enabled on any port.
> *
> * This function prepares the switch device for a safe shutdown while taking
> * into account the Wake-on-LAN (WoL) settings on the user ports. It updates
> * the wol_enabled flag accordingly to reflect whether WoL is active on any
> * port.
> */
> static void ksz_wol_pre_shutdown(struct ksz_device *dev)
>
>
> AIs seem to catch it but that's not ideal..
>
Yes, hopefully we can have this patch merged soon:
https://lore.kernel.org/all/20260507023232.4108680-1-shuicheng.lin@intel.com/
giving:
Warning: init/test001.c:13 Excess function parameter 'wol_enabled' description in 'ksz_wol_pre_shutdown'
--
~Randy
prev parent reply other threads:[~2026-05-15 1:58 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-15 1:49 kernel-doc no longer warns about leftover argument doc? Jakub Kicinski
2026-05-15 1:58 ` Randy Dunlap [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1ff1d237-fd32-4373-aaef-d19743bb2ea4@infradead.org \
--to=rdunlap@infradead.org \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox