Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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

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 `@comp` parameter. Update the comment to correctly document
the `zl3073x_fw_component_flash()` function and its arguments.

Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
Reviewed-by: Ivan Vecera <ivecera@redhat.com>
Link: https://patch.msgid.link/20251112055642.2597450-1-kriish.sharma2006@gmail.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Kriish Sharma and committed by
Jakub Kicinski
992b7d5f 205305c0

+3 -3
+3 -3
drivers/dpll/zl3073x/fw.c
··· 352 352 } 353 353 354 354 /** 355 - * zl3073x_flash_bundle_flash - Flash all components 355 + * zl3073x_fw_component_flash - Flash all components 356 356 * @zldev: zl3073x device structure 357 - * @components: pointer to components array 357 + * @comp: pointer to components array 358 358 * @extack: netlink extack pointer to report errors 359 359 * 360 - * Returns 0 in case of success or negative number otherwise. 360 + * Return: 0 in case of success or negative number otherwise. 361 361 */ 362 362 static int 363 363 zl3073x_fw_component_flash(struct zl3073x_dev *zldev,