Re: [net-next PATCH v2 4/6] octeontx2-pf: CN20K mbox REQ/ACK implementation for NIC PF
From: Jakub Kicinski
Date: Tue Oct 29 2024 - 19:08:18 EST
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:
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