[PATCH 1/2] usb: correct kernel-doc inconsistency

[PATCH 1/2] usb: correct kernel-doc inconsistency

[Colton Lewis]

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.
  */
-- 
2.26.2

[PATCH 2/2] usb: correct kernel-doc inconsistency

[Colton Lewis]

Silence documentation build warning by correcting kernel-doc comments
for usb_device and usb_device_driver structs.

./include/linux/usb.h:713: warning: Function parameter or member 'use_generic_driver' not described in 'usb_device'
./include/linux/usb.h:1253: warning: Function parameter or member 'match' not described in 'usb_device_driver'
./include/linux/usb.h:1253: warning: Function parameter or member 'id_table' not described in 'usb_device_driver'

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
 include/linux/usb.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/include/linux/usb.h b/include/linux/usb.h
index 9f3c721c70dc..88c80289e51f 100644
--- a/include/linux/usb.h
+++ b/include/linux/usb.h
@@ -621,6 +621,7 @@ struct usb3_lpm_parameters {
  *	be manipulated by those functions, with the bandwidth_mutex is held.
  * @hub_delay: cached value consisting of:
  *		parent->hub_delay + wHubDelay + tTPTransmissionDelay (40ns)
+ * @use_generic_driver: bit is set to use generic usb driver
  *
  *	Will be used as wValue for SetIsochDelay requests.
  *
@@ -1215,6 +1216,7 @@ struct usb_driver {
  * struct usb_device_driver - identifies USB device driver to usbcore
  * @name: The driver name should be unique among USB drivers,
  *	and should normally be the same as the module name.
+ * @match: Called to see if driver matches a device.
  * @probe: Called to see if the driver is willing to manage a particular
  *	device.  If it is, probe returns zero and uses dev_set_drvdata()
  *	to associate driver-specific data with the device.  If unwilling
@@ -1227,6 +1229,7 @@ struct usb_driver {
  * @dev_groups: Attributes attached to the device that will be created once it
  *	is bound to the driver.
  * @drvwrap: Driver-model core structure wrapper.
+ * @id_table: Array of device ids supported by this driver.
  * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
  *	for devices bound to this driver.
  * @generic_subclass: if set to 1, the generic USB driver's probe, disconnect,
-- 
2.26.2

Re: [PATCH 1/2] usb: correct kernel-doc inconsistency

[Randy Dunlap]

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.

-- 
~Randy

Re: [PATCH 2/2] usb: correct kernel-doc inconsistency

[Randy Dunlap]

On 7/6/20 9:52 PM, Colton Lewis wrote:
> Silence documentation build warning by correcting kernel-doc comments
> for usb_device and usb_device_driver structs.
> 
> ./include/linux/usb.h:713: warning: Function parameter or member 'use_generic_driver' not described in 'usb_device'
> ./include/linux/usb.h:1253: warning: Function parameter or member 'match' not described in 'usb_device_driver'
> ./include/linux/usb.h:1253: warning: Function parameter or member 'id_table' not described in 'usb_device_driver'
> 
> Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>

Hi,
I also sent a patch for this on June 28.


> ---
>  include/linux/usb.h | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/include/linux/usb.h b/include/linux/usb.h
> index 9f3c721c70dc..88c80289e51f 100644
> --- a/include/linux/usb.h
> +++ b/include/linux/usb.h
> @@ -621,6 +621,7 @@ struct usb3_lpm_parameters {
>   *	be manipulated by those functions, with the bandwidth_mutex is held.
>   * @hub_delay: cached value consisting of:
>   *		parent->hub_delay + wHubDelay + tTPTransmissionDelay (40ns)
> + * @use_generic_driver: bit is set to use generic usb driver
>   *
>   *	Will be used as wValue for SetIsochDelay requests.
>   *
> @@ -1215,6 +1216,7 @@ struct usb_driver {
>   * struct usb_device_driver - identifies USB device driver to usbcore
>   * @name: The driver name should be unique among USB drivers,
>   *	and should normally be the same as the module name.
> + * @match: Called to see if driver matches a device.
>   * @probe: Called to see if the driver is willing to manage a particular
>   *	device.  If it is, probe returns zero and uses dev_set_drvdata()
>   *	to associate driver-specific data with the device.  If unwilling
> @@ -1227,6 +1229,7 @@ struct usb_driver {
>   * @dev_groups: Attributes attached to the device that will be created once it
>   *	is bound to the driver.
>   * @drvwrap: Driver-model core structure wrapper.
> + * @id_table: Array of device ids supported by this driver.
>   * @supports_autosuspend: if set to 0, the USB core will not allow autosuspend
>   *	for devices bound to this driver.
>   * @generic_subclass: if set to 1, the generic USB driver's probe, disconnect,
> 


-- 
~Randy
Reported-by: Randy Dunlap <rdunlap@infradead.org>

Re: [PATCH 1/2] usb: correct kernel-doc inconsistency

[Greg KH]

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

Re: [PATCH 2/2] usb: correct kernel-doc inconsistency

[Greg KH]

On Mon, Jul 06, 2020 at 10:17:12PM -0700, Randy Dunlap wrote:
> On 7/6/20 9:52 PM, Colton Lewis wrote:
> > Silence documentation build warning by correcting kernel-doc comments
> > for usb_device and usb_device_driver structs.
> > 
> > ./include/linux/usb.h:713: warning: Function parameter or member 'use_generic_driver' not described in 'usb_device'
> > ./include/linux/usb.h:1253: warning: Function parameter or member 'match' not described in 'usb_device_driver'
> > ./include/linux/usb.h:1253: warning: Function parameter or member 'id_table' not described in 'usb_device_driver'
> > 
> > Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
> 
> Hi,
> I also sent a patch for this on June 28.

Its' in linux-next, right?

thanks,

greg k-h

Re: [PATCH 2/2] usb: correct kernel-doc inconsistency

[Randy Dunlap]

On 7/7/20 11:02 AM, Greg KH wrote:
> On Mon, Jul 06, 2020 at 10:17:12PM -0700, Randy Dunlap wrote:
>> On 7/6/20 9:52 PM, Colton Lewis wrote:
>>> Silence documentation build warning by correcting kernel-doc comments
>>> for usb_device and usb_device_driver structs.
>>>
>>> ./include/linux/usb.h:713: warning: Function parameter or member 'use_generic_driver' not described in 'usb_device'
>>> ./include/linux/usb.h:1253: warning: Function parameter or member 'match' not described in 'usb_device_driver'
>>> ./include/linux/usb.h:1253: warning: Function parameter or member 'id_table' not described in 'usb_device_driver'
>>>
>>> Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
>>
>> Hi,
>> I also sent a patch for this on June 28.
> 
> Its' in linux-next, right?

Yes, it is.

> thanks,
> 
> greg k-h


ta.
-- 
~Randy

Re: [PATCH 1/2] usb: correct kernel-doc inconsistency

[Randy Dunlap]

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/


-- 
~Randy