Thread (4 messages) 4 messages, 4 authors, 2021-03-31

Re: [PATCH] ARM: OMAP1: fix incorrect kernel-doc comment syntax in file

From: Tony Lindgren <tony@atomide.com>
Date: 2021-03-31 06:09:07
Also in: linux-arm-kernel, linux-doc, linux-omap, lkml

* Aditya Srivastava [off-list ref] [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
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help