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

-----Original Message-----
From: Jakub Kicinski <kuba@kernel.org>
Sent: Wednesday, October 30, 2024 4:37 AM
To: Sai Krishna Gajula <redacted>
Cc: davem@davemloft.net; edumazet@google.com; pabeni@redhat.com;
netdev@vger.kernel.org; linux-kernel@vger.kernel.org; Sunil Kovvuri
Goutham [off-list ref]; Geethasowjanya Akula
[off-list ref]; Linu Cherian [off-list ref]; Jerin Jacob
[off-list ref]; Hariprasad Kelam [off-list ref]; Subbaraya
Sundeep Bhatta [off-list ref]; kalesh-
anakkur.purayil@broadcom.com
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.

quoted

+

On Wed, 23 Oct 2024 00:24:08 +0530 Sai Krishna wrote:

quoted

+/**
+ * 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