linux-kernel - Re: [PATCH 07/30] iio: light: si1145: 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]

Date:   Sat, 18 Jul 2020 16:40:14 +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, Chuhong Yuan <hslester96@...il.com>,
        Dan Leonard <leonard.crestez@...el.com>
Subject: Re: [PATCH 07/30] iio: light: si1145: Demote obvious misuse of
 kerneldoc to standard comment blocks

On Fri, 17 Jul 2020 17:55:15 +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/light/si1145.c:192: warning: Function parameter or member 'data' not described in '__si1145_command_reset'
>  drivers/iio/light/si1145.c:228: warning: Function parameter or member 'data' not described in 'si1145_command'
>  drivers/iio/light/si1145.c:228: warning: Function parameter or member 'cmd' not described in 'si1145_command'
>  drivers/iio/light/si1145.c:1186: warning: Function parameter or member 'trig' not described in 'si1145_trigger_set_state'
>  drivers/iio/light/si1145.c:1186: warning: Function parameter or member 'state' not described in 'si1145_trigger_set_state'
> 
> Cc: Chuhong Yuan <hslester96@...il.com>
> Cc: Dan Leonard <leonard.crestez@...el.com>
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
Applied.

Thanks,

J
> ---
>  drivers/iio/light/si1145.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/iio/light/si1145.c b/drivers/iio/light/si1145.c
> index 0476c2bc81384..37a6a59030929 100644
> --- a/drivers/iio/light/si1145.c
> +++ b/drivers/iio/light/si1145.c
> @@ -181,7 +181,7 @@ struct si1145_data {
>  	int meas_rate;
>  };
>  
> -/**
> +/*
>   * __si1145_command_reset() - Send CMD_NOP and wait for response 0
>   *
>   * Does not modify data->rsp_seq
> @@ -215,7 +215,7 @@ static int __si1145_command_reset(struct si1145_data *data)
>  	}
>  }
>  
> -/**
> +/*
>   * si1145_command() - Execute a command and poll the response register
>   *
>   * All conversion overflows are reported as -EOVERFLOW
> @@ -1176,7 +1176,7 @@ static const struct iio_buffer_setup_ops si1145_buffer_setup_ops = {
>  	.validate_scan_mask = si1145_validate_scan_mask,
>  };
>  
> -/**
> +/*
>   * si1145_trigger_set_state() - Set trigger state
>   *
>   * When not using triggers interrupts are disabled and measurement rate is