| Message ID | 20210330205330.26345-1-yashsri421@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | ARM: OMAP1: fix incorrect kernel-doc comment syntax in file | expand |
On 3/30/21 1:53 PM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for arch/arm/mach-omap1/timer.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: expecting prototype for OMAP1 Dual(). Prototype was for OMAP1610_GPTIMER1_BASE() 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> Acked-by: Randy Dunlap <rdunlap@infradead.org> > --- > * Applies perfectly on next-20210326 > > arch/arm/mach-omap1/timer.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/arch/arm/mach-omap1/timer.c b/arch/arm/mach-omap1/timer.c > index 97fc2096b970..0411d5508d63 100644 > --- a/arch/arm/mach-omap1/timer.c > +++ b/arch/arm/mach-omap1/timer.c > @@ -1,4 +1,4 @@ > -/** > +/* > * OMAP1 Dual-Mode Timers - platform device registration > * > * Contains first level initialization routines which internally >
Hi, On Wed, Mar 31, 2021 at 02:23:30AM +0530, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for arch/arm/mach-omap1/timer.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: expecting prototype for OMAP1 Dual(). Prototype was for OMAP1610_GPTIMER1_BASE() 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> Acked-by: Aaro Koskinen <aaro.koskinen@iki.fi> A. > --- > * Applies perfectly on next-20210326 > > arch/arm/mach-omap1/timer.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/arch/arm/mach-omap1/timer.c b/arch/arm/mach-omap1/timer.c > index 97fc2096b970..0411d5508d63 100644 > --- a/arch/arm/mach-omap1/timer.c > +++ b/arch/arm/mach-omap1/timer.c > @@ -1,4 +1,4 @@ > -/** > +/* > * OMAP1 Dual-Mode Timers - platform device registration > * > * Contains first level initialization routines which internally > -- > 2.17.1 >
* Aditya Srivastava <yashsri421@gmail.com> [210330 23:54]: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for arch/arm/mach-omap1/timer.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: expecting prototype for OMAP1 Dual(). Prototype was for OMAP1610_GPTIMER1_BASE() instead" > > 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
diff --git a/arch/arm/mach-omap1/timer.c b/arch/arm/mach-omap1/timer.c index 97fc2096b970..0411d5508d63 100644 --- a/arch/arm/mach-omap1/timer.c +++ b/arch/arm/mach-omap1/timer.c @@ -1,4 +1,4 @@ -/** +/* * OMAP1 Dual-Mode Timers - platform device registration * * Contains first level initialization routines which internally
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments. The header for arch/arm/mach-omap1/timer.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: expecting prototype for OMAP1 Dual(). Prototype was for OMAP1610_GPTIMER1_BASE() 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-20210326 arch/arm/mach-omap1/timer.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)