[PATCH] win_minmax: fix kernel-doc syntax in file header

[PATCH] win_minmax: fix kernel-doc syntax in file header

[Aditya Srivastava]

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for include/linux/win_minmax.h 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: expecting prototype for c(). Prototype was for MINMAX_H() instead

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>
---
* Applies perfectly on next-20210514

 include/linux/win_minmax.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/win_minmax.h b/include/linux/win_minmax.h
index 4ca2842d2842..54bd6f133fa6 100644
--- a/include/linux/win_minmax.h
+++ b/include/linux/win_minmax.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0 */
-/**
+/*
  * lib/minmax.c: windowed min/max tracker by Kathleen Nichols.
  *
  */
-- 
2.17.1

[PATCH] win_minmax: fix kernel-doc syntax in file header

[Aditya Srivastava]

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for include/linux/win_minmax.h 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: expecting prototype for c(). Prototype was for MINMAX_H() instead

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>
---
* Applies perfectly on next-20210514

 include/linux/win_minmax.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/win_minmax.h b/include/linux/win_minmax.h
index 4ca2842d2842..54bd6f133fa6 100644
--- a/include/linux/win_minmax.h
+++ b/include/linux/win_minmax.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0 */
-/**
+/*
  * lib/minmax.c: windowed min/max tracker by Kathleen Nichols.
  *
  */
-- 
2.17.1

_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

Re: [PATCH] win_minmax: fix kernel-doc syntax in file header

[Randy Dunlap]

On 5/18/21 11:03 AM, Aditya Srivastava wrote:
> 
> 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>
> ---
> * Applies perfectly on next-20210514
> 
>  include/linux/win_minmax.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

-- 
~Randy

Re: [PATCH] win_minmax: fix kernel-doc syntax in file header

[Randy Dunlap]

On 5/18/21 11:03 AM, Aditya Srivastava wrote:
> 
> 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>
> ---
> * Applies perfectly on next-20210514
> 
>  include/linux/win_minmax.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

-- 
~Randy

_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees