| Message ID | 20200707045207.235540-1-colton.w.lewis@protonmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [1/2] usb: correct kernel-doc inconsistency | expand |
On 7/6/20 9:52 PM, Colton Lewis wrote: > Silence documentation build warning by correcting kernel-doc comment > for sub_validate_langid function. > > ./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' > > Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com> > --- > drivers/usb/gadget/usbstring.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/drivers/usb/gadget/usbstring.c b/drivers/usb/gadget/usbstring.c > index 58a4d3325090..119505fac777 100644 > --- a/drivers/usb/gadget/usbstring.c > +++ b/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. > */ > Hi, I sent a patch for this on June 28, but it has not yet been merged anywhere AFAIK.
On Mon, Jul 06, 2020 at 10:14:24PM -0700, Randy Dunlap wrote: > On 7/6/20 9:52 PM, Colton Lewis wrote: > > Silence documentation build warning by correcting kernel-doc comment > > for sub_validate_langid function. > > > > ./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' > > > > Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com> > > --- > > drivers/usb/gadget/usbstring.c | 2 +- > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > diff --git a/drivers/usb/gadget/usbstring.c b/drivers/usb/gadget/usbstring.c > > index 58a4d3325090..119505fac777 100644 > > --- a/drivers/usb/gadget/usbstring.c > > +++ b/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. > > */ > > > > Hi, > I sent a patch for this on June 28, but it has not yet been merged anywhere > AFAIK. Have a message-id? I don't see it in my queue. thanks, greg k-h
On 7/7/20 11:02 AM, Greg KH wrote: > On Mon, Jul 06, 2020 at 10:14:24PM -0700, Randy Dunlap wrote: >> On 7/6/20 9:52 PM, Colton Lewis wrote: >>> Silence documentation build warning by correcting kernel-doc comment >>> for sub_validate_langid function. >>> >>> ./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' >>> >>> Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com> >>> --- >>> drivers/usb/gadget/usbstring.c | 2 +- >>> 1 file changed, 1 insertion(+), 1 deletion(-) >>> >>> diff --git a/drivers/usb/gadget/usbstring.c b/drivers/usb/gadget/usbstring.c >>> index 58a4d3325090..119505fac777 100644 >>> --- a/drivers/usb/gadget/usbstring.c >>> +++ b/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. >>> */ >>> >> >> Hi, >> I sent a patch for this on June 28, but it has not yet been merged anywhere >> AFAIK. > > Have a message-id? I don't see it in my queue. Sure: <b49b7e07-8986-f185-3a99-a088419a532b@infradead.org> https://lore.kernel.org/linux-usb/b49b7e07-8986-f185-3a99-a088419a532b@infradead.org/
diff --git a/drivers/usb/gadget/usbstring.c b/drivers/usb/gadget/usbstring.c index 58a4d3325090..119505fac777 100644 --- a/drivers/usb/gadget/usbstring.c +++ b/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. */
Silence documentation build warning by correcting kernel-doc comment for sub_validate_langid function. ./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' Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com> --- drivers/usb/gadget/usbstring.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)