Re: [net-next PATCH v2 4/6] octeontx2-pf: CN20K mbox REQ/ACK implementation for NIC PF

[Sai Krishna Gajula]

> -----Original Message-----
> From: Jakub Kicinski <kuba@xxxxxxxxxx>
> Sent: Wednesday, October 30, 2024 4:37 AM
> To: Sai Krishna Gajula <saikrishnag@xxxxxxxxxxx>
> Cc: davem@xxxxxxxxxxxxx; edumazet@xxxxxxxxxx; pabeni@xxxxxxxxxx;
> netdev@xxxxxxxxxxxxxxx; linux-kernel@xxxxxxxxxxxxxxx; Sunil Kovvuri
> Goutham <sgoutham@xxxxxxxxxxx>; Geethasowjanya Akula
> <gakula@xxxxxxxxxxx>; Linu Cherian <lcherian@xxxxxxxxxxx>; Jerin Jacob
> <jerinj@xxxxxxxxxxx>; Hariprasad Kelam <hkelam@xxxxxxxxxxx>; Subbaraya
> Sundeep Bhatta <sbhatta@xxxxxxxxxxx>; kalesh-
> anakkur.purayil@xxxxxxxxxxxx
> Subject: Re: [net-next PATCH v2 4/6] octeontx2-pf: CN20K mbox
> REQ/ACK implementation for NIC PF
> 
> On Wed, 23 Oct 2024 00: 24: 08 +0530 Sai Krishna wrote: > +/** > + * CN20k
> RVU PF MBOX Interrupt Vector Enumeration > + * > + * Vectors 0 - 3 are
> compatible with pre cn20k and hence > + * existing macros are being reused.
> > +
> On Wed, 23 Oct 2024 00:24:08 +0530 Sai Krishna wrote:
> > +/**
> > + * CN20k RVU PF MBOX Interrupt Vector Enumeration
> > + *
> > + * Vectors 0 - 3 are compatible with pre cn20k and hence
> > + * existing macros are being reused.
> > + */
> 
> Please don't use /** unless the comment is in kernel-doc format.
> It causes warnings for documentation extractors:

Ack,  Will submit V3 patch with correcting the error.

> 
>  drivers/net/ethernet/marvell/octeontx2/af/cn20k/struct.h:12: warning: This
> comment starts with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
>   * CN20k RVU PF MBOX Interrupt Vector Enumeration
>  drivers/net/ethernet/marvell/octeontx2/af/cn20k/struct.h:12: warning:
> missing initial short description on line:
>   * CN20k RVU PF MBOX Interrupt Vector Enumeration
> --
> pw-bot: cr

Thanks,
Sai