Re: [PATCH] crypto: chelsio: fix incorrect kernel-doc comment syntax in file

From: Herbert Xu
Date: Fri Apr 09 2021 - 03:41:07 EST


On Mon, Mar 29, 2021 at 04:15:14PM +0530, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/crypto/chelsio/chcr_core.c follows this syntax, but
> the content inside does not comply with kernel-doc.
>
> This line was probably not meant for kernel-doc parsing, but is parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
> causes unexpected warning from kernel-doc:
> "warning: wrong kernel-doc identifier on line:
> * This file is part of the Chelsio T4/T5/T6 Ethernet driver for Linux."
>
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
>
> Signed-off-by: Aditya Srivastava <yashsri421@xxxxxxxxx>
> ---
> drivers/crypto/chelsio/chcr_core.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)

This patch doesn't apply against cryptodev. Thanks.
--
Email: Herbert Xu <herbert@xxxxxxxxxxxxxxxxxxx>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt