* [PATCH] usb: dwc3: imx8mp: fix incorrect kernel-doc comment syntax
@ 2021-03-29 14:26 Aditya Srivastava
2021-03-29 16:43 ` Fabio Estevam
2021-03-29 17:02 ` Randy Dunlap
0 siblings, 2 replies; 3+ messages in thread
From: Aditya Srivastava @ 2021-03-29 14:26 UTC (permalink / raw)
To: balbi
Cc: festevam, yashsri421, s.hauer, rdunlap, linux-doc, linux-kernel,
linux-usb, linux-imx, kernel, shawnguo, linux-arm-kernel,
linux-kernel-mentees
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 <yashsri421@gmail.com>
---
* Applies perfectly on next-20210326
drivers/usb/dwc3/dwc3-imx8mp.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/usb/dwc3/dwc3-imx8mp.c b/drivers/usb/dwc3/dwc3-imx8mp.c
index 75f0042b998b..b13cfab89d53 100644
--- a/drivers/usb/dwc3/dwc3-imx8mp.c
+++ b/drivers/usb/dwc3/dwc3-imx8mp.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0
-/**
+/*
* dwc3-imx8mp.c - NXP imx8mp Specific Glue layer
*
* Copyright (c) 2020 NXP.
--
2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] usb: dwc3: imx8mp: fix incorrect kernel-doc comment syntax
2021-03-29 14:26 [PATCH] usb: dwc3: imx8mp: fix incorrect kernel-doc comment syntax Aditya Srivastava
@ 2021-03-29 16:43 ` Fabio Estevam
2021-03-29 17:02 ` Randy Dunlap
1 sibling, 0 replies; 3+ messages in thread
From: Fabio Estevam @ 2021-03-29 16:43 UTC (permalink / raw)
To: Aditya Srivastava
Cc: Felipe Balbi, USB list, linux-doc, Sascha Hauer, Randy Dunlap,
linux-kernel, NXP Linux Team, Sascha Hauer, Shawn Guo,
moderated list:ARM/FREESCALE IMX / MXC ARM ARCHITECTURE,
linux-kernel-mentees
Hi Aditya,
On Mon, Mar 29, 2021 at 11:26 AM Aditya Srivastava <yashsri421@gmail.com> 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 <yashsri421@gmail.com>
It looks good, thanks:
Reviewed-by: Fabio Estevam <festevam@gmail.com>
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] usb: dwc3: imx8mp: fix incorrect kernel-doc comment syntax
2021-03-29 14:26 [PATCH] usb: dwc3: imx8mp: fix incorrect kernel-doc comment syntax Aditya Srivastava
2021-03-29 16:43 ` Fabio Estevam
@ 2021-03-29 17:02 ` Randy Dunlap
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2021-03-29 17:02 UTC (permalink / raw)
To: Aditya Srivastava, balbi
Cc: linux-doc, shawnguo, s.hauer, linux-usb, linux-kernel, linux-imx,
kernel, festevam, linux-arm-kernel, linux-kernel-mentees
On 3/29/21 7:26 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-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 <yashsri421@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
> ---
> * Applies perfectly on next-20210326
>
> drivers/usb/dwc3/dwc3-imx8mp.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/usb/dwc3/dwc3-imx8mp.c b/drivers/usb/dwc3/dwc3-imx8mp.c
> index 75f0042b998b..b13cfab89d53 100644
> --- a/drivers/usb/dwc3/dwc3-imx8mp.c
> +++ b/drivers/usb/dwc3/dwc3-imx8mp.c
> @@ -1,5 +1,5 @@
> // SPDX-License-Identifier: GPL-2.0
> -/**
> +/*
> * dwc3-imx8mp.c - NXP imx8mp Specific Glue layer
> *
> * Copyright (c) 2020 NXP.
>
--
~Randy
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-03-29 17:02 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-29 14:26 [PATCH] usb: dwc3: imx8mp: fix incorrect kernel-doc comment syntax Aditya Srivastava
2021-03-29 16:43 ` Fabio Estevam
2021-03-29 17:02 ` 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).