linux-kernel - Re: [PATCH 02/15] w1: ds2433: correct kerneldoc annotation

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: <84fd6222-89e8-58de-f386-b51af8cf9ebe@infradead.org>
Date:   Sat, 15 Apr 2023 09:08:37 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>,
        linux-kernel@...r.kernel.org
Cc:     Evgeniy Polyakov <zbr@...emap.net>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Arnd Bergmann <arnd@...db.de>, Olof Johansson <olof@...om.net>,
        soc@...nel.org, linux-arm-kernel@...ts.infradead.org
Subject: Re: [PATCH 02/15] w1: ds2433: correct kerneldoc annotation



On 4/15/23 03:42, Krzysztof Kozlowski wrote:
> Correct kerneldoc comments (or drop annotation) to fix:
> 
>   w1_ds2433.c:46: warning: This comment starts with '/**', but isn't a kernel-doc comment.
>   w1_ds2433.c:141: warning: This comment starts with '/**', but isn't a kernel-doc comment.
> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>

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

Thanks.

> ---
>  drivers/w1/slaves/w1_ds2433.c | 15 ++++++++-------
>  1 file changed, 8 insertions(+), 7 deletions(-)
> 
> diff --git a/drivers/w1/slaves/w1_ds2433.c b/drivers/w1/slaves/w1_ds2433.c
> index 0f72df15a024..6134ca2f37fe 100644
> --- a/drivers/w1/slaves/w1_ds2433.c
> +++ b/drivers/w1/slaves/w1_ds2433.c
> @@ -42,7 +42,7 @@ struct w1_f23_data {
>  	u32	validcrc;
>  };
>  
> -/**
> +/*
>   * Check the file size bounds and adjusts count as needed.
>   * This would not be needed if the file size didn't reset to 0 after a write.
>   */
> @@ -138,16 +138,17 @@ static ssize_t eeprom_read(struct file *filp, struct kobject *kobj,
>  }
>  
>  /**
> - * Writes to the scratchpad and reads it back for verification.
> + * w1_f23_write() - Writes to the scratchpad and reads it back for verification.
> + * @sl:		The slave structure
> + * @addr:	Address for the write
> + * @len:	length must be <= (W1_PAGE_SIZE - (addr & W1_PAGE_MASK))
> + * @data:	The data to write
> + *
>   * Then copies the scratchpad to EEPROM.
>   * The data must be on one page.
>   * The master must be locked.
>   *
> - * @param sl	The slave structure
> - * @param addr	Address for the write
> - * @param len   length must be <= (W1_PAGE_SIZE - (addr & W1_PAGE_MASK))
> - * @param data	The data to write
> - * @return	0=Success -1=failure
> + * Return:	0=Success, -1=failure
>   */
>  static int w1_f23_write(struct w1_slave *sl, int addr, int len, const u8 *data)
>  {

-- 
~Randy