linux-kernel - Re: [PATCH -next] hwmon: Fix some kernel-doc comments

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: <540e654b-904e-4201-b526-c9150d6b08d8@infradead.org>
Date:   Fri, 10 Nov 2023 19:06:27 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Yang Li <yang.lee@...ux.alibaba.com>, jdelvare@...e.com,
        linux@...ck-us.net
Cc:     linux-hwmon@...r.kernel.org, linux-kernel@...r.kernel.org,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH -next] hwmon: Fix some kernel-doc comments



On 11/9/23 21:53, Yang Li wrote:
> Fix some kernel-doc comments to silence the warnings:
> drivers/hwmon/sht4x.c:65: warning: Function parameter or member 'valid' not described in 'sht4x_data'
> drivers/hwmon/sht4x.c:73: warning: Function parameter or member 'data' not described in 'sht4x_read_values'
> drivers/hwmon/sht4x.c:73: warning: Excess function parameter 'sht4x_data' description in 'sht4x_read_values'
> 
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7220
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>

Acked-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.

> ---
>  drivers/hwmon/sht4x.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/hwmon/sht4x.c b/drivers/hwmon/sht4x.c
> index 7ee797410458..4883755d4b1e 100644
> --- a/drivers/hwmon/sht4x.c
> +++ b/drivers/hwmon/sht4x.c
> @@ -49,6 +49,7 @@ DECLARE_CRC8_TABLE(sht4x_crc8_table);
>   * struct sht4x_data - All the data required to operate an SHT4X chip
>   * @client: the i2c client associated with the SHT4X
>   * @lock: a mutex that is used to prevent parallel access to the i2c client
> + * @valid: validity of fields below
>   * @update_interval: the minimum poll interval
>   * @last_updated: the previous time that the SHT4X was polled
>   * @temperature: the latest temperature value received from the SHT4X
> @@ -66,7 +67,7 @@ struct sht4x_data {
>  
>  /**
>   * sht4x_read_values() - read and parse the raw data from the SHT4X
> - * @sht4x_data: the struct sht4x_data to use for the lock
> + * @data: the struct sht4x_data to use for the lock
>   * Return: 0 if successful, -ERRNO if not
>   */
>  static int sht4x_read_values(struct sht4x_data *data)

-- 
~Randy