[27/30] usb: class: cdc-wdm: Provide description for usb_cdc_wdm_register()'s manage_power arg

Message ID 20200702144625.2533530-28-lee.jones@linaro.org
State Superseded
Headers show
Series
  • Fix a bunch of W=1 issues in USB
Related show

Commit Message

Lee Jones July 2, 2020, 2:46 p.m.
A good attempt was made to document everything else.

Fixes the following W=1 kernel build warning(s):

 drivers/usb/class/cdc-wdm.c:961: warning: Function parameter or member 'manage_power' not described in 'usb_cdc_wdm_register'

Cc: Oliver Neukum <oneukum@suse.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/usb/class/cdc-wdm.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

-- 
2.25.1

Comments

Greg KH July 3, 2020, 7:32 a.m. | #1
On Thu, Jul 02, 2020 at 03:46:22PM +0100, Lee Jones wrote:
> A good attempt was made to document everything else.

> 

> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/usb/class/cdc-wdm.c:961: warning: Function parameter or member 'manage_power' not described in 'usb_cdc_wdm_register'

> 

> Cc: Oliver Neukum <oneukum@suse.com>

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/usb/class/cdc-wdm.c | 3 ++-

>  1 file changed, 2 insertions(+), 1 deletion(-)

> 

> diff --git a/drivers/usb/class/cdc-wdm.c b/drivers/usb/class/cdc-wdm.c

> index e3db6fbeadef8..4dceaeca46e73 100644

> --- a/drivers/usb/class/cdc-wdm.c

> +++ b/drivers/usb/class/cdc-wdm.c

> @@ -940,7 +940,8 @@ static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)

>   * @intf: usb interface the subdriver will associate with

>   * @ep: interrupt endpoint to monitor for notifications

>   * @bufsize: maximum message size to support for read/write

> - *

> + * @manage_power: call-back invoked during open and release to

> + *                manage the device's power 

>   * Create WDM usb class character device and associate it with intf

>   * without binding, allowing another driver to manage the interface.

>   *


You just added a coding style warning :(

Hint, set your editor to flag trailing whitespace with a BIG RED COLOR
so that you don't do that.  If you use vim, that can be done with:
	highlight WhitespaceEOL ctermbg=red guibg=red
	match WhitespaceEOL /\s\+$/
in your .vimrc

For other sane editors, I'm sure there are ways to do it as well.

Please fix this patch up and send it in a new series, I've dropped it
from this one.

thanks,

greg k-h

Patch

diff --git a/drivers/usb/class/cdc-wdm.c b/drivers/usb/class/cdc-wdm.c
index e3db6fbeadef8..4dceaeca46e73 100644
--- a/drivers/usb/class/cdc-wdm.c
+++ b/drivers/usb/class/cdc-wdm.c
@@ -940,7 +940,8 @@  static int wdm_probe(struct usb_interface *intf, const struct usb_device_id *id)
  * @intf: usb interface the subdriver will associate with
  * @ep: interrupt endpoint to monitor for notifications
  * @bufsize: maximum message size to support for read/write
- *
+ * @manage_power: call-back invoked during open and release to
+ *                manage the device's power 
  * Create WDM usb class character device and associate it with intf
  * without binding, allowing another driver to manage the interface.
  *