linux-kernel - Re: [PATCH 24/30] iio: imu: inv_mpu6050: inv_mpu_core: Demote obvious misuse of kerneldoc to standard comment blocks

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200718170243.7d5ae3a9@archlinux>
Date:   Sat, 18 Jul 2020 17:02:43 +0100
From:   Jonathan Cameron <jic23@...nel.org>
To:     Lee Jones <lee.jones@...aro.org>
Cc:     knaack.h@....de, lars@...afoo.de, pmeerw@...erw.net,
        linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org,
        linux-iio@...r.kernel.org,
        Jean-Baptiste Maneyrol <jmaneyrol@...ensense.com>
Subject: Re: [PATCH 24/30] iio: imu: inv_mpu6050: inv_mpu_core: Demote
 obvious misuse of kerneldoc to standard comment blocks

On Fri, 17 Jul 2020 17:55:32 +0100
Lee Jones <lee.jones@...aro.org> wrote:

> No attempt has been made to document any of the demoted functions here.
> 
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:444: warning: Function parameter or member 'st' not described in 'inv_mpu6050_set_lpf_regs'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:444: warning: Function parameter or member 'val' not described in 'inv_mpu6050_set_lpf_regs'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:480: warning: Function parameter or member 'indio_dev' not described in 'inv_mpu6050_init_config'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:862: warning: Function parameter or member 'st' not described in 'inv_mpu6050_set_lpf'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:862: warning: Function parameter or member 'rate' not described in 'inv_mpu6050_set_lpf'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:893: warning: Function parameter or member 'dev' not described in 'inv_mpu6050_fifo_rate_store'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:893: warning: Function parameter or member 'attr' not described in 'inv_mpu6050_fifo_rate_store'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:893: warning: Function parameter or member 'buf' not described in 'inv_mpu6050_fifo_rate_store'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:893: warning: Function parameter or member 'count' not described in 'inv_mpu6050_fifo_rate_store'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:954: warning: Function parameter or member 'dev' not described in 'inv_fifo_rate_show'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:954: warning: Function parameter or member 'attr' not described in 'inv_fifo_rate_show'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:954: warning: Function parameter or member 'buf' not described in 'inv_fifo_rate_show'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:975: warning: Function parameter or member 'dev' not described in 'inv_attr_show'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:975: warning: Function parameter or member 'attr' not described in 'inv_attr_show'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:975: warning: Function parameter or member 'buf' not described in 'inv_attr_show'
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c:1282: warning: Function parameter or member 'st' not described in 'inv_check_and_setup_chip'
> 
> Cc: Jean-Baptiste Maneyrol <jmaneyrol@...ensense.com>
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
Applied.

Thanks,

Jonathan

> ---
>  drivers/iio/imu/inv_mpu6050/inv_mpu_core.c | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/drivers/iio/imu/inv_mpu6050/inv_mpu_core.c b/drivers/iio/imu/inv_mpu6050/inv_mpu_core.c
> index 4d604fe842e5d..f6b2b2e8f1010 100644
> --- a/drivers/iio/imu/inv_mpu6050/inv_mpu_core.c
> +++ b/drivers/iio/imu/inv_mpu6050/inv_mpu_core.c
> @@ -433,7 +433,7 @@ static int inv_mpu6050_set_gyro_fsr(struct inv_mpu6050_state *st,
>  	return regmap_write(st->map, st->reg->gyro_config, data);
>  }
>  
> -/**
> +/*
>   *  inv_mpu6050_set_lpf_regs() - set low pass filter registers, chip dependent
>   *
>   *  MPU60xx/MPU9150 use only 1 register for accelerometer + gyroscope
> @@ -467,7 +467,7 @@ static int inv_mpu6050_set_lpf_regs(struct inv_mpu6050_state *st,
>  	return regmap_write(st->map, st->reg->accel_lpf, val);
>  }
>  
> -/**
> +/*
>   *  inv_mpu6050_init_config() - Initialize hardware, disable FIFO.
>   *
>   *  Initial configuration:
> @@ -847,7 +847,7 @@ static int inv_mpu6050_write_raw(struct iio_dev *indio_dev,
>  	return result;
>  }
>  
> -/**
> +/*
>   *  inv_mpu6050_set_lpf() - set low pass filer based on fifo rate.
>   *
>   *                  Based on the Nyquist principle, the bandwidth of the low
> @@ -884,7 +884,7 @@ static int inv_mpu6050_set_lpf(struct inv_mpu6050_state *st, int rate)
>  	return 0;
>  }
>  
> -/**
> +/*
>   * inv_mpu6050_fifo_rate_store() - Set fifo rate.
>   */
>  static ssize_t
> @@ -945,7 +945,7 @@ inv_mpu6050_fifo_rate_store(struct device *dev, struct device_attribute *attr,
>  	return count;
>  }
>  
> -/**
> +/*
>   * inv_fifo_rate_show() - Get the current sampling rate.
>   */
>  static ssize_t
> @@ -962,7 +962,7 @@ inv_fifo_rate_show(struct device *dev, struct device_attribute *attr,
>  	return scnprintf(buf, PAGE_SIZE, "%u\n", fifo_rate);
>  }
>  
> -/**
> +/*
>   * inv_attr_show() - calling this function will show current
>   *                    parameters.
>   *
> @@ -1275,7 +1275,7 @@ static const struct iio_info mpu_info = {
>  	.debugfs_reg_access = &inv_mpu6050_reg_access,
>  };
>  
> -/**
> +/*
>   *  inv_check_and_setup_chip() - check and setup chip.
>   */
>  static int inv_check_and_setup_chip(struct inv_mpu6050_state *st)