Re: [PATCH 16/30] iio: accel: sca3000: Fix 2 misspellings and demote nonconforming kerneldocs

From: Jonathan Cameron
Date: Sat Jul 18 2020 - 11:51:48 EST


On Fri, 17 Jul 2020 17:55:24 +0100
Lee Jones <lee.jones@xxxxxxxxxx> wrote:

> Fixes the following W=1 kernel build warning(s):
>
> drivers/iio/accel/sca3000.c:210: warning: Function parameter or member 'mot_det_mult_xz' not described in 'sca3000_chip_info'
> drivers/iio/accel/sca3000.c:210: warning: Function parameter or member 'mot_det_mult_y' not described in 'sca3000_chip_info'
> drivers/iio/accel/sca3000.c:871: warning: Function parameter or member 'indio_dev' not described in 'sca3000_read_event_value'
> drivers/iio/accel/sca3000.c:871: warning: Function parameter or member 'chan' not described in 'sca3000_read_event_value'
> drivers/iio/accel/sca3000.c:871: warning: Function parameter or member 'type' not described in 'sca3000_read_event_value'
> drivers/iio/accel/sca3000.c:871: warning: Function parameter or member 'dir' not described in 'sca3000_read_event_value'
> drivers/iio/accel/sca3000.c:871: warning: Function parameter or member 'info' not described in 'sca3000_read_event_value'
> drivers/iio/accel/sca3000.c:871: warning: Function parameter or member 'val' not described in 'sca3000_read_event_value'
> drivers/iio/accel/sca3000.c:871: warning: Function parameter or member 'val2' not described in 'sca3000_read_event_value'
> drivers/iio/accel/sca3000.c:1110: warning: Function parameter or member 'indio_dev' not described in 'sca3000_read_event_config'
> drivers/iio/accel/sca3000.c:1110: warning: Function parameter or member 'chan' not described in 'sca3000_read_event_config'
> drivers/iio/accel/sca3000.c:1110: warning: Function parameter or member 'type' not described in 'sca3000_read_event_config'
> drivers/iio/accel/sca3000.c:1110: warning: Function parameter or member 'dir' not described in 'sca3000_read_event_config'
>
> Cc: Christophe JAILLET <christophe.jaillet@xxxxxxxxxx>
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
Applied.

Thanks,

Jonathan

> ---
> drivers/iio/accel/sca3000.c | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/iio/accel/sca3000.c b/drivers/iio/accel/sca3000.c
> index 6e429072e44a4..3952187166ffa 100644
> --- a/drivers/iio/accel/sca3000.c
> +++ b/drivers/iio/accel/sca3000.c
> @@ -186,9 +186,9 @@ struct sca3000_state {
> * @option_mode_2_freq: option mode 2 sampling frequency
> * @option_mode_2_3db_freq: 3db cutoff frequency of the low pass filter for
> * the second option mode.
> - * @mod_det_mult_xz: Bit wise multipliers to calculate the threshold
> + * @mot_det_mult_xz: Bit wise multipliers to calculate the threshold
> * for motion detection in the x and z axis.
> - * @mod_det_mult_y: Bit wise multipliers to calculate the threshold
> + * @mot_det_mult_y: Bit wise multipliers to calculate the threshold
> * for motion detection in the y axis.
> *
> * This structure is used to hold information about the functionality of a given
> @@ -859,9 +859,9 @@ static ssize_t sca3000_read_av_freq(struct device *dev,
> */
> static IIO_DEV_ATTR_SAMP_FREQ_AVAIL(sca3000_read_av_freq);
>
> -/**
> +/*
> * sca3000_read_event_value() - query of a threshold or period
> - **/
> + */
> static int sca3000_read_event_value(struct iio_dev *indio_dev,
> const struct iio_chan_spec *chan,
> enum iio_event_type type,
> @@ -1100,9 +1100,9 @@ static irqreturn_t sca3000_event_handler(int irq, void *private)
> return IRQ_HANDLED;
> }
>
> -/**
> +/*
> * sca3000_read_event_config() what events are enabled
> - **/
> + */
> static int sca3000_read_event_config(struct iio_dev *indio_dev,
> const struct iio_chan_spec *chan,
> enum iio_event_type type,