linux-kernel - Re: [PATCH] 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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <1A4EAB2B-A848-4571-88B2-A33A850F272F@redhat.com>
Date: Mon, 10 Nov 2025 20:59:13 +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>
CC: netdev@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] dpll: zl3073x: fix kernel-doc name and missing parameter in fw.c



On November 10, 2025 8:50:30 PM GMT+01:00, Kriish Sharma <kriish.sharma2006@...il.com> 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
>
>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>
>---
> drivers/dpll/zl3073x/fw.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
>diff --git a/drivers/dpll/zl3073x/fw.c b/drivers/dpll/zl3073x/fw.c
>index def37fe8d9b0..ca5210c0829d 100644
>--- a/drivers/dpll/zl3073x/fw.c
>+++ b/drivers/dpll/zl3073x/fw.c
>@@ -352,9 +352,9 @@ 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.

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