* [PATCH] usb: dwc3: st: fix incorrect kernel-doc comment syntax in file
@ 2021-03-29 13:20 Aditya Srivastava
2021-03-29 18:15 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Aditya Srivastava @ 2021-03-29 13:20 UTC (permalink / raw)
To: patrice.chotard
Cc: yashsri421, lukas.bulwahn, balbi, gregkh, rdunlap,
linux-kernel-mentees, linux-doc, linux-arm-kernel, linux-usb,
linux-kernel
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for drivers/usb/dwc3/dwc3-st.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 CLKRST_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 <yashsri421@gmail.com>
---
* Applies perfectly on next-20210326
drivers/usb/dwc3/dwc3-st.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/usb/dwc3/dwc3-st.c b/drivers/usb/dwc3/dwc3-st.c
index b06b7092b1a2..166b5bde45cb 100644
--- a/drivers/usb/dwc3/dwc3-st.c
+++ b/drivers/usb/dwc3/dwc3-st.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0+
-/**
+/*
* dwc3-st.c Support for dwc3 platform devices on ST Microelectronics platforms
*
* This is a small driver for the dwc3 to provide the glue logic
--
2.17.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] usb: dwc3: st: fix incorrect kernel-doc comment syntax in file
2021-03-29 13:20 [PATCH] usb: dwc3: st: fix incorrect kernel-doc comment syntax in file Aditya Srivastava
@ 2021-03-29 18:15 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2021-03-29 18:15 UTC (permalink / raw)
To: Aditya Srivastava, patrice.chotard
Cc: lukas.bulwahn, balbi, gregkh, linux-kernel-mentees, linux-doc,
linux-arm-kernel, linux-usb, linux-kernel
On 3/29/21 6:20 AM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/usb/dwc3/dwc3-st.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 CLKRST_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 <yashsri421@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> * Applies perfectly on next-20210326
>
> drivers/usb/dwc3/dwc3-st.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/usb/dwc3/dwc3-st.c b/drivers/usb/dwc3/dwc3-st.c
> index b06b7092b1a2..166b5bde45cb 100644
> --- a/drivers/usb/dwc3/dwc3-st.c
> +++ b/drivers/usb/dwc3/dwc3-st.c
> @@ -1,5 +1,5 @@
> // SPDX-License-Identifier: GPL-2.0+
> -/**
> +/*
> * dwc3-st.c Support for dwc3 platform devices on ST Microelectronics platforms
> *
> * This is a small driver for the dwc3 to provide the glue logic
>
--
~Randy
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-03-29 18:17 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-29 13:20 [PATCH] usb: dwc3: st: fix incorrect kernel-doc comment syntax in file Aditya Srivastava
2021-03-29 18:15 ` Randy Dunlap
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).