linux-kernel - Re: [PATCH 29/30] iio: imu: kmx61: Fix formatting in kerneldoc function headers

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 for Android: free password hash cracker in your pocket

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

Message-ID: <20200718161728.2faa55f2@archlinux>
Date:   Sat, 18 Jul 2020 16:17:28 +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, Daniel Baluta <daniel.baluta@...el.com>
Subject: Re: [PATCH 29/30] iio: imu: kmx61: Fix formatting in kerneldoc
 function headers

On Thu, 16 Jul 2020 14:59:27 +0100
Lee Jones <lee.jones@...aro.org> wrote:

> Kerneldoc expects attributes/parameters to be in '@*.: ' format.
> 
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/iio/imu/kmx61.c:327: warning: Function parameter or member 'data' not described in 'kmx61_set_mode'
>  drivers/iio/imu/kmx61.c:327: warning: Function parameter or member 'mode' not described in 'kmx61_set_mode'
>  drivers/iio/imu/kmx61.c:327: warning: Function parameter or member 'device' not described in 'kmx61_set_mode'
>  drivers/iio/imu/kmx61.c:327: warning: Function parameter or member 'update' not described in 'kmx61_set_mode'
>  drivers/iio/imu/kmx61.c:731: warning: Function parameter or member 'data' not described in 'kmx61_set_power_state'
>  drivers/iio/imu/kmx61.c:731: warning: Function parameter or member 'on' not described in 'kmx61_set_power_state'
>  drivers/iio/imu/kmx61.c:731: warning: Function parameter or member 'device' not described in 'kmx61_set_power_state'
> 
> Cc: Daniel Baluta <daniel.baluta@...el.com>
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
Applied.
Thanks,

Jonathan

> ---
>  drivers/iio/imu/kmx61.c | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/drivers/iio/imu/kmx61.c b/drivers/iio/imu/kmx61.c
> index e67466100aff4..d0cee2e09884d 100644
> --- a/drivers/iio/imu/kmx61.c
> +++ b/drivers/iio/imu/kmx61.c
> @@ -312,10 +312,10 @@ static int kmx61_convert_wake_up_odr_to_bit(int val, int val2)
>  
>  /**
>   * kmx61_set_mode() - set KMX61 device operating mode
> - * @data - kmx61 device private data pointer
> - * @mode - bitmask, indicating operating mode for @device
> - * @device - bitmask, indicating device for which @mode needs to be set
> - * @update - update stby bits stored in device's private  @data
> + * @data: kmx61 device private data pointer
> + * @mode: bitmask, indicating operating mode for @device
> + * @device: bitmask, indicating device for which @mode needs to be set
> + * @update: update stby bits stored in device's private  @data
>   *
>   * For each sensor (accelerometer/magnetometer) there are two operating modes
>   * STANDBY and OPERATION. Neither accel nor magn can be disabled independently
> @@ -718,9 +718,9 @@ static int kmx61_setup_any_motion_interrupt(struct kmx61_data *data,
>  
>  /**
>   * kmx61_set_power_state() - set power state for kmx61 @device
> - * @data - kmx61 device private pointer
> - * @on - power state to be set for @device
> - * @device - bitmask indicating device for which @on state needs to be set
> + * @data: kmx61 device private pointer
> + * @on: power state to be set for @device
> + * @device: bitmask indicating device for which @on state needs to be set
>   *
>   * Notice that when ACC power state needs to be set to ON and MAG is in
>   * OPERATION then we know that kmx61_runtime_resume was already called