linux-kernel - RE: [PATCH net v1 1/1] idpf: Fix kernel-doc descriptions to avoid warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <IA3PR11MB8986A3FDF77D49598C5F4C89E5DEA@IA3PR11MB8986.namprd11.prod.outlook.com>
Date: Wed, 26 Nov 2025 07:24:40 +0000
From: "Loktionov, Aleksandr" <aleksandr.loktionov@...el.com>
To: "Kitszel, Przemyslaw" <przemyslaw.kitszel@...el.com>, Andy Shevchenko
	<andriy.shevchenko@...ux.intel.com>, "Nguyen, Anthony L"
	<anthony.l.nguyen@...el.com>, "intel-wired-lan@...ts.osuosl.org"
	<intel-wired-lan@...ts.osuosl.org>, "netdev@...r.kernel.org"
	<netdev@...r.kernel.org>
CC: Andrew Lunn <andrew+netdev@...n.ch>, "linux-kernel@...r.kernel.org"
	<linux-kernel@...r.kernel.org>, "David S. Miller" <davem@...emloft.net>, Eric
 Dumazet <edumazet@...gle.com>, Jakub Kicinski <kuba@...nel.org>, "Paolo
 Abeni" <pabeni@...hat.com>
Subject: RE: [PATCH net v1 1/1] idpf: Fix kernel-doc descriptions to avoid
 warnings



> -----Original Message-----
> From: Kitszel, Przemyslaw <przemyslaw.kitszel@...el.com>
> Sent: Wednesday, November 26, 2025 7:30 AM
> To: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>; Nguyen, Anthony L
> <anthony.l.nguyen@...el.com>; intel-wired-lan@...ts.osuosl.org;
> netdev@...r.kernel.org; Loktionov, Aleksandr <aleksandr.loktionov@...el.com>
> Cc: Andrew Lunn <andrew+netdev@...n.ch>; linux-kernel@...r.kernel.org; David
> S. Miller <davem@...emloft.net>; Eric Dumazet <edumazet@...gle.com>; Jakub
> Kicinski <kuba@...nel.org>; Paolo Abeni <pabeni@...hat.com>
> Subject: Re: [PATCH net v1 1/1] idpf: Fix kernel-doc descriptions to avoid
> warnings
> 
> On 11/24/25 18:42, Andy Shevchenko wrote:
> > In many functions the Return section is missing. Fix kernel-doc
> > descriptions to address that and other warnings.
> >
> > Before the change:
> >
> > $ scripts/kernel-doc -none -Wreturn
> > drivers/net/ethernet/intel/idpf/idpf_txrx.c 2>&1 | wc -l
> > 85
> >
> > Signed-off-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
> > ---
> >   drivers/net/ethernet/intel/idpf/idpf_txrx.c | 96 +++++++++++++--------
> >   1 file changed, 59 insertions(+), 37 deletions(-)
> 
> this is small change and leaves the driver good for long future to come I
> think it is net-positive in terms of minor annoyances for rebase or
> backports, so:
> Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@...el.com>
> 
> side note:
> Alex did analogous work for the ice driver, and I stopped him going public,
> as it was counted in thousands lines changes for little benefit
> 
> usual rant about kdoc warnings:
> agghr!!
> 

...

> >   /**
> > - * idpf_tx_splitq_has_room - check if enough Tx splitq resources are
> > available
> > + * idpf_txq_has_room - check if enough Tx splitq resources are
> > + available
> >    * @tx_q: the queue to be checked
> >    * @descs_needed: number of descriptors required for this packet
> >    * @bufs_needed: number of Tx buffers required for this packet @@
> > -2527,6 +2530,8 @@ unsigned int idpf_tx_res_count_required(struct
> idpf_tx_queue *txq,
> >    * idpf_tx_splitq_bump_ntu - adjust NTU and generation
> >    * @txq: the tx ring to wrap
> >    * @ntu: ring index to bump
> > + *
> > + * Return: the next ring index hopping to 0 when wraps around
> >    */
> >   static unsigned int idpf_tx_splitq_bump_ntu(struct idpf_tx_queue *txq,
> u16 ntu)
Strange idpf_tx_splitq_bump_ntu() is not idpf_txq_has_room 
Can you doublecheck?

Otherwise looks good
Alex 😊

...