diff mbox series

[23/25] HID: hid-sensor-hub: Move 'hsdev' description to correct struct definition

Message ID 20210326143458.508959-25-lee.jones@linaro.org (mailing list archive)
State New
Headers show
Series Rid W=1 warnings from HID | expand

Commit Message

Lee Jones March 26, 2021, 2:34 p.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/hid/hid-sensor-hub.c:54: warning: Function parameter or member 'hsdev' not described in 'hid_sensor_hub_callbacks_list'

Cc: Jiri Kosina <jikos@kernel.org>
Cc: Jonathan Cameron <jic23@kernel.org>
Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: linux-input@vger.kernel.org
Cc: linux-iio@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/hid/hid-sensor-hub.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jonathan Cameron March 29, 2021, 11:30 a.m. UTC | #1
On Fri, 26 Mar 2021 14:34:56 +0000
Lee Jones <lee.jones@linaro.org> wrote:

> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/hid/hid-sensor-hub.c:54: warning: Function parameter or member 'hsdev' not described in 'hid_sensor_hub_callbacks_list'
> 

Perhaps nice to mention that this was a result of

ca2ed12f163b ("HID: hid-sensor-hub: Processing for duplicate physical ids")

> Cc: Jiri Kosina <jikos@kernel.org>
> Cc: Jonathan Cameron <jic23@kernel.org>
> Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
> Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
> Cc: linux-input@vger.kernel.org
> Cc: linux-iio@vger.kernel.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> ---
>  drivers/hid/hid-sensor-hub.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/hid/hid-sensor-hub.c b/drivers/hid/hid-sensor-hub.c
> index 36b6852f75dd5..95cf88f3bafb9 100644
> --- a/drivers/hid/hid-sensor-hub.c
> +++ b/drivers/hid/hid-sensor-hub.c
> @@ -18,7 +18,6 @@
>  
>  /**
>   * struct sensor_hub_data - Hold a instance data for a HID hub device
> - * @hsdev:		Stored hid instance for current hub device.
>   * @mutex:		Mutex to serialize synchronous request.
>   * @lock:		Spin lock to protect pending request structure.
>   * @dyn_callback_list:	Holds callback function
> @@ -41,6 +40,7 @@ struct sensor_hub_data {
>   * struct hid_sensor_hub_callbacks_list - Stores callback list
>   * @list:		list head.
>   * @usage_id:		usage id for a physical device.
> + * @hsdev:		Stored hid instance for current hub device.
>   * @usage_callback:	Stores registered callback functions.
>   * @priv:		Private data for a physical device.
>   */
Lee Jones March 29, 2021, 1 p.m. UTC | #2
On Mon, 29 Mar 2021, Jonathan Cameron wrote:

> On Fri, 26 Mar 2021 14:34:56 +0000
> Lee Jones <lee.jones@linaro.org> wrote:
> 
> > Fixes the following W=1 kernel build warning(s):
> > 
> >  drivers/hid/hid-sensor-hub.c:54: warning: Function parameter or member 'hsdev' not described in 'hid_sensor_hub_callbacks_list'
> > 
> 
> Perhaps nice to mention that this was a result of
> 
> ca2ed12f163b ("HID: hid-sensor-hub: Processing for duplicate physical ids")

I only tend to do that for Fixes: tags, but Greg has made it clear
that these patches are not suitable for stable.

> > Cc: Jiri Kosina <jikos@kernel.org>
> > Cc: Jonathan Cameron <jic23@kernel.org>
> > Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
> > Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
> > Cc: linux-input@vger.kernel.org
> > Cc: linux-iio@vger.kernel.org
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>

> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Thanks dude, much appreciated.
Jonathan Cameron March 29, 2021, 3:22 p.m. UTC | #3
On Mon, 29 Mar 2021 14:00:07 +0100
Lee Jones <lee.jones@linaro.org> wrote:

> On Mon, 29 Mar 2021, Jonathan Cameron wrote:
> 
> > On Fri, 26 Mar 2021 14:34:56 +0000
> > Lee Jones <lee.jones@linaro.org> wrote:
> >   
> > > Fixes the following W=1 kernel build warning(s):
> > > 
> > >  drivers/hid/hid-sensor-hub.c:54: warning: Function parameter or member 'hsdev' not described in 'hid_sensor_hub_callbacks_list'
> > >   
> > 
> > Perhaps nice to mention that this was a result of
> > 
> > ca2ed12f163b ("HID: hid-sensor-hub: Processing for duplicate physical ids")  
> 
> I only tend to do that for Fixes: tags, but Greg has made it clear
> that these patches are not suitable for stable.

Ok, I was deliberately not including Fixes for that reason, but
I guess some other script might moan if we do that :)

> 
> > > Cc: Jiri Kosina <jikos@kernel.org>
> > > Cc: Jonathan Cameron <jic23@kernel.org>
> > > Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
> > > Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
> > > Cc: linux-input@vger.kernel.org
> > > Cc: linux-iio@vger.kernel.org
> > > Signed-off-by: Lee Jones <lee.jones@linaro.org>  
> 
> > Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>  
> 
> Thanks dude, much appreciated.
>
diff mbox series

Patch

diff --git a/drivers/hid/hid-sensor-hub.c b/drivers/hid/hid-sensor-hub.c
index 36b6852f75dd5..95cf88f3bafb9 100644
--- a/drivers/hid/hid-sensor-hub.c
+++ b/drivers/hid/hid-sensor-hub.c
@@ -18,7 +18,6 @@ 
 
 /**
  * struct sensor_hub_data - Hold a instance data for a HID hub device
- * @hsdev:		Stored hid instance for current hub device.
  * @mutex:		Mutex to serialize synchronous request.
  * @lock:		Spin lock to protect pending request structure.
  * @dyn_callback_list:	Holds callback function
@@ -41,6 +40,7 @@  struct sensor_hub_data {
  * struct hid_sensor_hub_callbacks_list - Stores callback list
  * @list:		list head.
  * @usage_id:		usage id for a physical device.
+ * @hsdev:		Stored hid instance for current hub device.
  * @usage_callback:	Stores registered callback functions.
  * @priv:		Private data for a physical device.
  */