* kernel-doc no longer warns about leftover argument doc?
@ 2026-05-15 1:49 Jakub Kicinski
2026-05-15 1:58 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Jakub Kicinski @ 2026-05-15 1:49 UTC (permalink / raw)
To: Mauro Carvalho Chehab; +Cc: linux-doc
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..
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: kernel-doc no longer warns about leftover argument doc?
2026-05-15 1:49 kernel-doc no longer warns about leftover argument doc? Jakub Kicinski
@ 2026-05-15 1:58 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2026-05-15 1:58 UTC (permalink / raw)
To: Jakub Kicinski, Mauro Carvalho Chehab; +Cc: linux-doc
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2026-05-15 1:58 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-05-15 1:49 kernel-doc no longer warns about leftover argument doc? Jakub Kicinski
2026-05-15 1:58 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox