* [PATCH] usb: cdns3: Corrected comment to align with kernel-doc comment
@ 2021-04-24 11:30 Souptick Joarder
2021-04-24 15:53 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Souptick Joarder @ 2021-04-24 11:30 UTC (permalink / raw)
To: peter.chen, pawell, rogerq, a-govindraju, gregkh
Cc: linux-usb, linux-kernel, Souptick Joarder
Kernel test robot throws below warning ->
drivers/usb/cdns3/cdns3-gadget.c:487: warning: This comment starts with
'/**', but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst
This patch will silence the warning.
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
---
drivers/usb/cdns3/cdns3-gadget.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/usb/cdns3/cdns3-gadget.c b/drivers/usb/cdns3/cdns3-gadget.c
index 9b1bd41..0280a38 100644
--- a/drivers/usb/cdns3/cdns3-gadget.c
+++ b/drivers/usb/cdns3/cdns3-gadget.c
@@ -483,7 +483,7 @@ static void __cdns3_descmiss_copy_data(struct usb_request *request,
}
}
-/**
+/*
* cdns3_wa2_descmiss_copy_data copy data from internal requests to
* request queued by class driver.
* @priv_ep: extended endpoint object
--
1.9.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] usb: cdns3: Corrected comment to align with kernel-doc comment
2021-04-24 11:30 [PATCH] usb: cdns3: Corrected comment to align with kernel-doc comment Souptick Joarder
@ 2021-04-24 15:53 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2021-04-24 15:53 UTC (permalink / raw)
To: Souptick Joarder, peter.chen, pawell, rogerq, a-govindraju, gregkh
Cc: linux-usb, linux-kernel
On 4/24/21 4:30 AM, Souptick Joarder wrote:
> Kernel test robot throws below warning ->
>
> drivers/usb/cdns3/cdns3-gadget.c:487: warning: This comment starts with
> '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
>
> This patch will silence the warning.
>
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
> ---
> drivers/usb/cdns3/cdns3-gadget.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/usb/cdns3/cdns3-gadget.c b/drivers/usb/cdns3/cdns3-gadget.c
> index 9b1bd41..0280a38 100644
> --- a/drivers/usb/cdns3/cdns3-gadget.c
> +++ b/drivers/usb/cdns3/cdns3-gadget.c
> @@ -483,7 +483,7 @@ static void __cdns3_descmiss_copy_data(struct usb_request *request,
> }
> }
>
> -/**
> +/*
> * cdns3_wa2_descmiss_copy_data copy data from internal requests to
Please just insert a hyphen/dash between the function name and its description.
> * request queued by class driver.
> * @priv_ep: extended endpoint object
>
thanks.
--
~Randy
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-04-24 15:54 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-24 11:30 [PATCH] usb: cdns3: Corrected comment to align with kernel-doc comment Souptick Joarder
2021-04-24 15:53 ` 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).