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

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

[Kriish Sharma]

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 `@comp` 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@gmail.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.
-- 
2.34.1

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

[Ivan Vecera]

On November 10, 2025 8:50:30 PM GMT+01:00, Kriish Sharma <kriish.sharma2006@gmail.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 `@comp` 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@gmail.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@redhat.com>

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

[Jakub Kicinski]

On Mon, 10 Nov 2025 19:50:30 +0000 Kriish Sharma wrote:
> Documentation build reported:

What do you mean by "documentation build"? make htmldocs?

>   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 `@comp` 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@gmail.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.

This now makes the kernel-doc script realize that the return value is
not documented. Please also add a : after the Returns on the last line
-- 
pw-bot: cr

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

[Kriish Sharma]

On Wed, Nov 12, 2025 at 7:12 AM Jakub Kicinski <kuba@kernel.org> wrote:
> What do you mean by "documentation build"? make htmldocs?

Yes, I ran make htmldocs , which triggered the kernel-doc warnings.

> This now makes the kernel-doc script realize that the return value is
> not documented. Please also add a : after the Returns on the last line

Thanks for the review, Jakub.
I’ll add the missing colon after “Returns” in the kernel-doc comment
and send a v2 shortly.

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

[Jakub Kicinski]

On Wed, 12 Nov 2025 09:54:32 +0530 Kriish Sharma wrote:
> On Wed, Nov 12, 2025 at 7:12 AM Jakub Kicinski <kuba@kernel.org> wrote:
> > What do you mean by "documentation build"? make htmldocs?  
> 
> Yes, I ran make htmldocs , which triggered the kernel-doc warnings.

Strange, I thought make htmldocs only complains when file in question
is rendered as part of some page. Maybe something changed...