2020-06-29 03:09:56

by Randy Dunlap

Subject: [PATCH] usb: gadget: fix langid kernel-doc warning in usbstring.c

From: Randy Dunlap <[email protected]>

Fix spelling of the 'langid' function argument in the kernel-doc
notation to quieten a kernel-doc warning.

../drivers/usb/gadget/usbstring.c:77: warning: Function parameter or member 'langid' not described in 'usb_validate_langid'
../drivers/usb/gadget/usbstring.c:77: warning: Excess function parameter 'lang' description in 'usb_validate_langid'

Fixes: 17309a6a4356 ("usb: gadget: add "usb_validate_langid" function")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Tao Ren <[email protected]>
Cc: Felipe Balbi <[email protected]>
---
drivers/usb/gadget/usbstring.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20200626.orig/drivers/usb/gadget/usbstring.c
+++ linux-next-20200626/drivers/usb/gadget/usbstring.c
@@ -68,7 +68,7 @@ EXPORT_SYMBOL_GPL(usb_gadget_get_string)

/**
* usb_validate_langid - validate usb language identifiers
- * @lang: usb language identifier
+ * @langid: usb language identifier
*
* Returns true for valid language identifier, otherwise false.
*/

2020-06-29 23:52:53

by Tao Ren

Subject: Re: [PATCH] usb: gadget: fix langid kernel-doc warning in usbstring.c

On Sun, Jun 28, 2020 at 08:08:03PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <[email protected]>
>
> Fix spelling of the 'langid' function argument in the kernel-doc
> notation to quieten a kernel-doc warning.
>
> ../drivers/usb/gadget/usbstring.c:77: warning: Function parameter or member 'langid' not described in 'usb_validate_langid'
> ../drivers/usb/gadget/usbstring.c:77: warning: Excess function parameter 'lang' description in 'usb_validate_langid'
>
> Fixes: 17309a6a4356 ("usb: gadget: add "usb_validate_langid" function")
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Tao Ren <[email protected]>
> Cc: Felipe Balbi <[email protected]>

Thanks for the fix, Randy!

Reviewed-by: Tao Ren <[email protected]>

> ---
> drivers/usb/gadget/usbstring.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-next-20200626.orig/drivers/usb/gadget/usbstring.c
> +++ linux-next-20200626/drivers/usb/gadget/usbstring.c
> @@ -68,7 +68,7 @@ EXPORT_SYMBOL_GPL(usb_gadget_get_string)
>
> /**
> * usb_validate_langid - validate usb language identifiers
> - * @lang: usb language identifier
> + * @langid: usb language identifier
> *
> * Returns true for valid language identifier, otherwise false.
> */
>