Thread (3 messages) 3 messages, 3 authors, 2021-03-29

Re: [PATCH] usb: dwc3: imx8mp: fix incorrect kernel-doc comment syntax

From: Fabio Estevam <festevam@gmail.com>
Date: 2021-03-29 16:44:52
Also in: linux-doc, linux-kernel-mentees, linux-usb, lkml

Hi Aditya,

On Mon, Mar 29, 2021 at 11:26 AM Aditya Srivastava [off-list ref] wrote:
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for drivers/usb/dwc3/dwc3-imx8mp.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 dwc3(). Prototype was for USB_WAKEUP_CTRL() 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 <redacted>
It looks good, thanks:

Reviewed-by: Fabio Estevam <festevam@gmail.com>

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help