diff mbox series

usb: fix kernel-doc warning

Message ID 20230918193505.7046-1-swarupkotikalapudi@gmail.com
State Superseded
Headers show
Series usb: fix kernel-doc warning | expand

Commit Message

swarup Sept. 18, 2023, 7:35 p.m. UTC
Fix kernel-doc warnings discovered in usb driver.
Fixes this warning:
warning: Function parameter or member 'gfladj_refclk_lpm_sel'
         not described in 'dwc3'

Signed-off-by: Swarup Laxman Kotiaklapudi <swarupkotikalapudi@gmail.com>
---
 drivers/usb/dwc3/core.h | 2 ++
 1 file changed, 2 insertions(+)

Comments

swarup Oct. 2, 2023, 3:40 p.m. UTC | #1
On Mon, Oct 02, 2023 at 04:42:03PM +0200, Greg KH wrote:
> On Tue, Sep 19, 2023 at 01:05:05AM +0530, Swarup Laxman Kotiaklapudi wrote:
> > Fix kernel-doc warnings discovered in usb driver.
> > Fixes this warning:
> > warning: Function parameter or member 'gfladj_refclk_lpm_sel'
> >          not described in 'dwc3'
> > 
> > Signed-off-by: Swarup Laxman Kotiaklapudi <swarupkotikalapudi@gmail.com>
> > ---
> >  drivers/usb/dwc3/core.h | 2 ++
> >  1 file changed, 2 insertions(+)
> 
> What commit id does this fix?
> 
> thanks,
> 
> greg k-h

Hi Greg,
Please find the commit id as mentioned below,
next time onwards i will mention it:

Fixes: 5cd07f96c0c6 ("usb: fix kernel-doc warning")

Thanks,
Swarup
Thinh Nguyen Oct. 2, 2023, 6:26 p.m. UTC | #2
On Mon, Oct 02, 2023, Swarup Laxman Kotiaklapudi wrote:
> Fix kernel-doc warnings discovered in usb driver.
> 
> Fixes this warning:
> warning: Function parameter or member 'gfladj_refclk_lpm_sel'
>          not described in 'dwc3'
> 
> Fixes: cf1202418e0b ("usb: fix kernel-doc warning")

This id doesn't match anything in the mainline kernel.

> Signed-off-by: Swarup Laxman Kotiaklapudi <swarupkotikalapudi@gmail.com>
> ---

Please note changes since v1 here.

>  drivers/usb/dwc3/core.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
> index a69ac67d89fe..078edfe0f88e 100644
> --- a/drivers/usb/dwc3/core.h
> +++ b/drivers/usb/dwc3/core.h
> @@ -1106,6 +1106,8 @@ struct dwc3_scratchpad_array {
>   *			instances in park mode.
>   * @parkmode_disable_hs_quirk: set if we need to disable all HishSpeed
>   *			instances in park mode.
> + * @gfladj_refclk_lpm_sel: set if we need to enable reference clock for LPM in
> + *                         Global Frame Length Adjustment register
>   * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
>   * @tx_de_emphasis: Tx de-emphasis value
>   *	0	- -6dB de-emphasis
> -- 
> 2.34.1
> 

Also, please prefix $subject line with "usb: dwc3:"

Thanks,
Thinh
diff mbox series

Patch

diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
index a69ac67d89fe..078edfe0f88e 100644
--- a/drivers/usb/dwc3/core.h
+++ b/drivers/usb/dwc3/core.h
@@ -1106,6 +1106,8 @@  struct dwc3_scratchpad_array {
  *			instances in park mode.
  * @parkmode_disable_hs_quirk: set if we need to disable all HishSpeed
  *			instances in park mode.
+ * @gfladj_refclk_lpm_sel: set if we need to enable reference clock for LPM in
+ *                         Global Frame Length Adjustment register
  * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
  * @tx_de_emphasis: Tx de-emphasis value
  *	0	- -6dB de-emphasis