[PATCH] iio:cros_ec_sensors: Fix a wrong function name in kernel doc.

[PATCH] iio:cros_ec_sensors: Fix a wrong function name in kernel doc.

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

cros_ec_sensors_read_data_unsafe() had wrong function name in kernel-doc
This shows up with W=1 builds.

No fixes tag because I don't want to waste time on this being
backported.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Guenter Roeck <groeck@chromium.org>
Cc: Douglas Anderson <dianders@chromium.org>
Cc: Gwendal Grignou <gwendal@chromium.org>
Cc: Enric Balletbo i Serra <enric.balletbo@collabora.com>
---
 drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c b/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
index f8824afe595e..ed9dd0ad5c03 100644
--- a/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
+++ b/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
@@ -559,7 +559,7 @@ static int cros_ec_sensors_read_until_not_busy(
 }
 
 /**
- * read_ec_sensors_data_unsafe() - read acceleration data from EC shared memory
+ * cros_ec_sensors_read_data_unsafe() - read acc data from EC shared memory
  * @indio_dev:	pointer to IIO device
  * @scan_mask:	bitmap of the sensor indices to scan
  * @data:	location to store data
-- 
2.30.1

Re: [PATCH] iio:cros_ec_sensors: Fix a wrong function name in kernel doc.

[Enric Balletbo i Serra]

Hi Jonathan,

Thank you for fix this.

On 13/3/21 15:53, Jonathan Cameron wrote:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> cros_ec_sensors_read_data_unsafe() had wrong function name in kernel-doc
> This shows up with W=1 builds.
> 
> No fixes tag because I don't want to waste time on this being
> backported.
> 
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Guenter Roeck <groeck@chromium.org>
> Cc: Douglas Anderson <dianders@chromium.org>
> Cc: Gwendal Grignou <gwendal@chromium.org>
> Cc: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> ---
>  drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c b/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
> index f8824afe595e..ed9dd0ad5c03 100644
> --- a/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
> +++ b/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
> @@ -559,7 +559,7 @@ static int cros_ec_sensors_read_until_not_busy(
>  }
>  
>  /**
> - * read_ec_sensors_data_unsafe() - read acceleration data from EC shared memory
> + * cros_ec_sensors_read_data_unsafe() - read acc data from EC shared memory


nit: Wouldn't be better to maintain the word 'acceleration' instead of replacing
for 'acc'. It is less than 100 characters in total so should be fine.

In any case:

Acked-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>

>   * @indio_dev:	pointer to IIO device
>   * @scan_mask:	bitmap of the sensor indices to scan
>   * @data:	location to store data
> 

Re: [PATCH] iio:cros_ec_sensors: Fix a wrong function name in kernel doc.

[Jonathan Cameron]

On Mon, 15 Mar 2021 11:35:44 +0100
Enric Balletbo i Serra <enric.balletbo@collabora.com> wrote:

> Hi Jonathan,
> 
> Thank you for fix this.
> 
> On 13/3/21 15:53, Jonathan Cameron wrote:
> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > 
> > cros_ec_sensors_read_data_unsafe() had wrong function name in kernel-doc
> > This shows up with W=1 builds.
> > 
> > No fixes tag because I don't want to waste time on this being
> > backported.
> > 
> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > Cc: Guenter Roeck <groeck@chromium.org>
> > Cc: Douglas Anderson <dianders@chromium.org>
> > Cc: Gwendal Grignou <gwendal@chromium.org>
> > Cc: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> > ---
> >  drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c b/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
> > index f8824afe595e..ed9dd0ad5c03 100644
> > --- a/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
> > +++ b/drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c
> > @@ -559,7 +559,7 @@ static int cros_ec_sensors_read_until_not_busy(
> >  }
> >  
> >  /**
> > - * read_ec_sensors_data_unsafe() - read acceleration data from EC shared memory
> > + * cros_ec_sensors_read_data_unsafe() - read acc data from EC shared memory  
> 
> 
> nit: Wouldn't be better to maintain the word 'acceleration' instead of replacing
> for 'acc'. It is less than 100 characters in total so should be fine.

I've put it back whilst applying.

> 
> In any case:
> 
> Acked-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>

Applied. Thanks,

Jonathan

> 
> >   * @indio_dev:	pointer to IIO device
> >   * @scan_mask:	bitmap of the sensor indices to scan
> >   * @data:	location to store data
> >