* [PATCH] ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file
@ 2021-03-30 20:59 Aditya Srivastava
2021-03-30 21:05 ` Randy Dunlap
2021-03-31 6:07 ` Tony Lindgren
0 siblings, 2 replies; 3+ messages in thread
From: Aditya Srivastava @ 2021-03-30 20:59 UTC (permalink / raw)
To: linux-kernel
Cc: yashsri421, lukas.bulwahn, rdunlap, tony, linux,
linux-kernel-mentees, linux-doc, linux-omap, linux-arm-kernel
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for arch/arm/mach-omap2/omap_twl.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:
* OMAP and TWL PMIC specific initializations."
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-20210326
arch/arm/mach-omap2/omap_twl.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/arch/arm/mach-omap2/omap_twl.c b/arch/arm/mach-omap2/omap_twl.c
index a642d3b39e50..d4dab041324d 100644
--- a/arch/arm/mach-omap2/omap_twl.c
+++ b/arch/arm/mach-omap2/omap_twl.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
* OMAP and TWL PMIC specific initializations.
*
* Copyright (C) 2010 Texas Instruments Incorporated.
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file
2021-03-30 20:59 [PATCH] ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file Aditya Srivastava
@ 2021-03-30 21:05 ` Randy Dunlap
2021-03-31 6:07 ` Tony Lindgren
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2021-03-30 21:05 UTC (permalink / raw)
To: Aditya Srivastava, linux-kernel
Cc: lukas.bulwahn, tony, linux, linux-kernel-mentees, linux-doc,
linux-omap, linux-arm-kernel
On 3/30/21 1:59 PM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for arch/arm/mach-omap2/omap_twl.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:
> * OMAP and TWL PMIC specific initializations."
>
> 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>
> ---
> * Applies perfectly on next-20210326
>
> arch/arm/mach-omap2/omap_twl.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/arch/arm/mach-omap2/omap_twl.c b/arch/arm/mach-omap2/omap_twl.c
> index a642d3b39e50..d4dab041324d 100644
> --- a/arch/arm/mach-omap2/omap_twl.c
> +++ b/arch/arm/mach-omap2/omap_twl.c
> @@ -1,5 +1,5 @@
> // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
> * OMAP and TWL PMIC specific initializations.
> *
> * Copyright (C) 2010 Texas Instruments Incorporated.
>
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file
2021-03-30 20:59 [PATCH] ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file Aditya Srivastava
2021-03-30 21:05 ` Randy Dunlap
@ 2021-03-31 6:07 ` Tony Lindgren
1 sibling, 0 replies; 3+ messages in thread
From: Tony Lindgren @ 2021-03-31 6:07 UTC (permalink / raw)
To: Aditya Srivastava
Cc: linux-kernel, lukas.bulwahn, rdunlap, linux,
linux-kernel-mentees, linux-doc, linux-omap, linux-arm-kernel
* Aditya Srivastava <yashsri421@gmail.com> [210331 00:00]:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for arch/arm/mach-omap2/omap_twl.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:
> * OMAP and TWL PMIC specific initializations."
>
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
Thanks applying into omap-for-v5.13/soc.
Tony
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-03-31 6:09 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-30 20:59 [PATCH] ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file Aditya Srivastava
2021-03-30 21:05 ` Randy Dunlap
2021-03-31 6:07 ` Tony Lindgren
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).