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

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: <20241029160657.2a0a2c91@kernel.org>
Date: Tue, 29 Oct 2024 16:06:57 -0700
From: Jakub Kicinski <kuba@...nel.org>
To: Sai Krishna <saikrishnag@...vell.com>
Cc: <davem@...emloft.net>, <edumazet@...gle.com>, <pabeni@...hat.com>,
 <netdev@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
 <sgoutham@...vell.com>, <gakula@...vell.com>, <lcherian@...vell.com>,
 <jerinj@...vell.com>, <hkelam@...vell.com>, <sbhatta@...vell.com>,
 <kalesh-anakkur.purayil@...adcom.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.
> + */

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