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

[Loktionov, Aleksandr]

> -----Original Message-----
> From: Kitszel, Przemyslaw <przemyslaw.kitszel@xxxxxxxxx>
> Sent: Wednesday, November 26, 2025 7:30 AM
> To: Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>; Nguyen, Anthony L
> <anthony.l.nguyen@xxxxxxxxx>; intel-wired-lan@xxxxxxxxxxxxxxxx;
> netdev@xxxxxxxxxxxxxxx; Loktionov, Aleksandr <aleksandr.loktionov@xxxxxxxxx>
> Cc: Andrew Lunn <andrew+netdev@xxxxxxx>; linux-kernel@xxxxxxxxxxxxxxx; David
> S. Miller <davem@xxxxxxxxxxxxx>; Eric Dumazet <edumazet@xxxxxxxxxx>; Jakub
> Kicinski <kuba@xxxxxxxxxx>; Paolo Abeni <pabeni@xxxxxxxxxx>
> 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@xxxxxxxxxxxxxxx>
> > ---
> >   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@xxxxxxxxx>
> 
> 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 😊

...