linux-kernel - Re: [PATCH v2] dpll: zl3073x: fix kernel-doc name and missing parameter in fw.c

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: <018e3129-e367-4637-8892-7eb83dcae40f@redhat.com>
Date: Thu, 13 Nov 2025 18:09:09 +0100
From: Ivan Vecera <ivecera@...hat.com>
To: Kriish Sharma <kriish.sharma2006@...il.com>,
 Prathosh Satish <Prathosh.Satish@...rochip.com>,
 Vadim Fedorenko <vadim.fedorenko@...ux.dev>,
 Arkadiusz Kubalewski <arkadiusz.kubalewski@...el.com>,
 Jiri Pirko <jiri@...nulli.us>, Jakub Kicinski <kuba@...nel.org>
Cc: netdev@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] dpll: zl3073x: fix kernel-doc name and missing
 parameter in fw.c

On 11/12/25 6:56 AM, Kriish Sharma wrote:
> Documentation build reported:
> 
>    Warning: drivers/dpll/zl3073x/fw.c:365 function parameter 'comp' not described in 'zl3073x_fw_component_flash'
>    Warning: drivers/dpll/zl3073x/fw.c:365 expecting prototype for zl3073x_flash_bundle_flash(). Prototype was for zl3073x_fw_component_flash() instead
>    Warning: drivers/dpll/zl3073x/fw.c:365 No description found for return value of 'zl3073x_fw_component_flash'
> 
> The kernel-doc comment above `zl3073x_fw_component_flash()` used the wrong
> function name (`zl3073x_flash_bundle_flash`) and omitted the `@...p` parameter.
> This patch updates the comment to correctly document the
> `zl3073x_fw_component_flash()` function and its arguments.
> 
> Fixes: ca017409da69 ("dpll: zl3073x: Add firmware loading functionality")
> Signed-off-by: Kriish Sharma <kriish.sharma2006@...il.com>
> ---
> v2:
>   - Added colon to fix kernel-doc warning for `Return:` line.
> 
> v1: https://lore.kernel.org/all/20251110195030.2248235-1-kriish.sharma2006@gmail.com
> 
>   drivers/dpll/zl3073x/fw.c | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/dpll/zl3073x/fw.c b/drivers/dpll/zl3073x/fw.c
> index def37fe8d9b0..55b638247f4b 100644
> --- a/drivers/dpll/zl3073x/fw.c
> +++ b/drivers/dpll/zl3073x/fw.c
> @@ -352,12 +352,12 @@ struct zl3073x_fw *zl3073x_fw_load(struct zl3073x_dev *zldev, const char *data,
>   }
>   
>   /**
> - * zl3073x_flash_bundle_flash - Flash all components
> + * zl3073x_fw_component_flash - Flash all components
>    * @zldev: zl3073x device structure
> - * @components: pointer to components array
> + * @comp: pointer to components array
>    * @extack: netlink extack pointer to report errors
>    *
> - * Returns 0 in case of success or negative number otherwise.
> + * Return: 0 in case of success or negative number otherwise.
>    */

Reviewed-by: Ivan Vecera <ivecera@...hat.com>