2020-07-17 16:57:01

by Lee Jones

Subject: [PATCH 09/30] iio: temperature: mlx90632: Function parameter descriptions must match exactly

'*'s are not welcome in kerneldoc parameter names.

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

drivers/iio/temperature/mlx90632.c:175: warning: Function parameter or member 'data' not described in 'mlx90632_perform_measurement'

Cc: Crt Mori <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/iio/temperature/mlx90632.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/iio/temperature/mlx90632.c b/drivers/iio/temperature/mlx90632.c
index eaca6ba068646..b9a8089be3f63 100644
--- a/drivers/iio/temperature/mlx90632.c
+++ b/drivers/iio/temperature/mlx90632.c
@@ -164,8 +164,8 @@ static s32 mlx90632_pwr_continuous(struct regmap *regmap)
}

/**
- * mlx90632_perform_measurement - Trigger and retrieve current measurement cycle
- * @*data: pointer to mlx90632_data object containing regmap information
+ * mlx90632_perform_measurement() - Trigger and retrieve current measurement cycle
+ * @data: pointer to mlx90632_data object containing regmap information
*
* Perform a measurement and return latest measurement cycle position reported
* by sensor. This is a blocking function for 500ms, as that is default sensor
--
2.25.1

2020-07-17 19:49:56

by Crt Mori

Subject: Re: [PATCH 09/30] iio: temperature: mlx90632: Function parameter descriptions must match exactly

Acked-by: Crt Mori <[email protected]>

On Fri, 17 Jul 2020 at 18:56, Lee Jones <[email protected]> wrote:
>
> '*'s are not welcome in kerneldoc parameter names.
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/iio/temperature/mlx90632.c:175: warning: Function parameter or member 'data' not described in 'mlx90632_perform_measurement'
>
> Cc: Crt Mori <[email protected]>
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/iio/temperature/mlx90632.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/iio/temperature/mlx90632.c b/drivers/iio/temperature/mlx90632.c
> index eaca6ba068646..b9a8089be3f63 100644
> --- a/drivers/iio/temperature/mlx90632.c
> +++ b/drivers/iio/temperature/mlx90632.c
> @@ -164,8 +164,8 @@ static s32 mlx90632_pwr_continuous(struct regmap *regmap)
> }
>
> /**
> - * mlx90632_perform_measurement - Trigger and retrieve current measurement cycle
> - * @*data: pointer to mlx90632_data object containing regmap information
> + * mlx90632_perform_measurement() - Trigger and retrieve current measurement cycle
> + * @data: pointer to mlx90632_data object containing regmap information
> *
> * Perform a measurement and return latest measurement cycle position reported
> * by sensor. This is a blocking function for 500ms, as that is default sensor
> --
> 2.25.1
>

2020-07-18 15:45:34

by Jonathan Cameron

Subject: Re: [PATCH 09/30] iio: temperature: mlx90632: Function parameter descriptions must match exactly

On Fri, 17 Jul 2020 21:48:06 +0200
Crt Mori <[email protected]> wrote:

> Acked-by: Crt Mori <[email protected]>
>
> On Fri, 17 Jul 2020 at 18:56, Lee Jones <[email protected]> wrote:
> >
> > '*'s are not welcome in kerneldoc parameter names.
> >
> > Fixes the following W=1 kernel build warning(s):
> >
> > drivers/iio/temperature/mlx90632.c:175: warning: Function parameter or member 'data' not described in 'mlx90632_perform_measurement'
> >
> > Cc: Crt Mori <[email protected]>
> > Signed-off-by: Lee Jones <[email protected]>
I got lazy on bothering about the addition of optional brackets.

Applied,

Thanks,

Jonathan

> > ---
> > drivers/iio/temperature/mlx90632.c | 4 ++--
> > 1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/iio/temperature/mlx90632.c b/drivers/iio/temperature/mlx90632.c
> > index eaca6ba068646..b9a8089be3f63 100644
> > --- a/drivers/iio/temperature/mlx90632.c
> > +++ b/drivers/iio/temperature/mlx90632.c
> > @@ -164,8 +164,8 @@ static s32 mlx90632_pwr_continuous(struct regmap *regmap)
> > }
> >
> > /**
> > - * mlx90632_perform_measurement - Trigger and retrieve current measurement cycle
> > - * @*data: pointer to mlx90632_data object containing regmap information
> > + * mlx90632_perform_measurement() - Trigger and retrieve current measurement cycle
> > + * @data: pointer to mlx90632_data object containing regmap information
> > *
> > * Perform a measurement and return latest measurement cycle position reported
> > * by sensor. This is a blocking function for 500ms, as that is default sensor
> > --
> > 2.25.1
> >