* [PATCH] crypto: chelsio: fix incorrect kernel-doc comment syntax in file
@ 2021-03-29 10:45 ` Aditya Srivastava
0 siblings, 0 replies; 6+ messages in thread
From: Aditya Srivastava @ 2021-03-29 10:45 UTC (permalink / raw)
To: herbert
Cc: yashsri421, lukas.bulwahn, linux-kernel-mentees, linux-doc,
rdunlap, ayush.sawal, vinay.yadav, rohitm, davem, linux-crypto,
linux-kernel
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@gmail.com>
---
drivers/crypto/chelsio/chcr_core.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/crypto/chelsio/chcr_core.c b/drivers/crypto/chelsio/chcr_core.c
index f91f9d762a45..f03ef4a23f96 100644
--- a/drivers/crypto/chelsio/chcr_core.c
+++ b/drivers/crypto/chelsio/chcr_core.c
@@ -1,4 +1,4 @@
-/**
+/*
* This file is part of the Chelsio T4/T5/T6 Ethernet driver for Linux.
*
* Copyright (C) 2011-2016 Chelsio Communications. All rights reserved.
--
2.17.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH] crypto: chelsio: fix incorrect kernel-doc comment syntax in file
@ 2021-03-29 10:45 ` Aditya Srivastava
0 siblings, 0 replies; 6+ messages in thread
From: Aditya Srivastava @ 2021-03-29 10:45 UTC (permalink / raw)
To: herbert
Cc: vinay.yadav, linux-doc, rdunlap, linux-kernel, yashsri421,
rohitm, linux-crypto, ayush.sawal, linux-kernel-mentees, davem
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@gmail.com>
---
drivers/crypto/chelsio/chcr_core.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/crypto/chelsio/chcr_core.c b/drivers/crypto/chelsio/chcr_core.c
index f91f9d762a45..f03ef4a23f96 100644
--- a/drivers/crypto/chelsio/chcr_core.c
+++ b/drivers/crypto/chelsio/chcr_core.c
@@ -1,4 +1,4 @@
-/**
+/*
* This file is part of the Chelsio T4/T5/T6 Ethernet driver for Linux.
*
* Copyright (C) 2011-2016 Chelsio Communications. All rights reserved.
--
2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] crypto: chelsio: fix incorrect kernel-doc comment syntax in file
2021-03-29 10:45 ` Aditya Srivastava
@ 2021-03-29 17:06 ` Randy Dunlap
-1 siblings, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2021-03-29 17:06 UTC (permalink / raw)
To: Aditya Srivastava, herbert
Cc: lukas.bulwahn, linux-kernel-mentees, linux-doc, ayush.sawal,
vinay.yadav, rohitm, davem, linux-crypto, linux-kernel
On 3/29/21 3:45 AM, 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@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
> ---
> drivers/crypto/chelsio/chcr_core.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/crypto/chelsio/chcr_core.c b/drivers/crypto/chelsio/chcr_core.c
> index f91f9d762a45..f03ef4a23f96 100644
> --- a/drivers/crypto/chelsio/chcr_core.c
> +++ b/drivers/crypto/chelsio/chcr_core.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
> * This file is part of the Chelsio T4/T5/T6 Ethernet driver for Linux.
> *
> * Copyright (C) 2011-2016 Chelsio Communications. All rights reserved.
>
--
~Randy
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] crypto: chelsio: fix incorrect kernel-doc comment syntax in file
@ 2021-03-29 17:06 ` Randy Dunlap
0 siblings, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2021-03-29 17:06 UTC (permalink / raw)
To: Aditya Srivastava, herbert
Cc: rohitm, vinay.yadav, linux-doc, linux-kernel, linux-crypto,
ayush.sawal, linux-kernel-mentees, davem
On 3/29/21 3:45 AM, 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@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
> ---
> drivers/crypto/chelsio/chcr_core.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/crypto/chelsio/chcr_core.c b/drivers/crypto/chelsio/chcr_core.c
> index f91f9d762a45..f03ef4a23f96 100644
> --- a/drivers/crypto/chelsio/chcr_core.c
> +++ b/drivers/crypto/chelsio/chcr_core.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
> * This file is part of the Chelsio T4/T5/T6 Ethernet driver for Linux.
> *
> * Copyright (C) 2011-2016 Chelsio Communications. All rights reserved.
>
--
~Randy
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] crypto: chelsio: fix incorrect kernel-doc comment syntax in file
2021-03-29 10:45 ` Aditya Srivastava
@ 2021-04-09 7:40 ` Herbert Xu
-1 siblings, 0 replies; 6+ messages in thread
From: Herbert Xu @ 2021-04-09 7:40 UTC (permalink / raw)
To: Aditya Srivastava
Cc: lukas.bulwahn, linux-kernel-mentees, linux-doc, rdunlap,
ayush.sawal, vinay.yadav, rohitm, davem, linux-crypto,
linux-kernel
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@gmail.com>
> ---
> 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@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] crypto: chelsio: fix incorrect kernel-doc comment syntax in file
@ 2021-04-09 7:40 ` Herbert Xu
0 siblings, 0 replies; 6+ messages in thread
From: Herbert Xu @ 2021-04-09 7:40 UTC (permalink / raw)
To: Aditya Srivastava
Cc: rdunlap, linux-doc, vinay.yadav, linux-kernel, rohitm,
linux-crypto, ayush.sawal, linux-kernel-mentees, davem
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@gmail.com>
> ---
> 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@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-04-09 7:41 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-29 10:45 [PATCH] crypto: chelsio: fix incorrect kernel-doc comment syntax in file Aditya Srivastava
2021-03-29 10:45 ` Aditya Srivastava
2021-03-29 17:06 ` Randy Dunlap
2021-03-29 17:06 ` Randy Dunlap
2021-04-09 7:40 ` Herbert Xu
2021-04-09 7:40 ` Herbert Xu
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.