efi/libstub: Describe missing 'out' parameter in efi_load_initrd

Hans Zhang · ardbiesheuvel · commit c8e1927e7f7d · 2025-05-09T11:24:00.000+02:00
The function efi_load_initrd() had a documentation warning due to the missing description for the 'out' parameter. Add the parameter description to the kernel-doc comment to resolve the warning and improve API documentation. Fixes the following compiler warning: drivers/firmware/efi/libstub/efi-stub-helper.c:611: warning: Function parameter or struct member 'out' not described in 'efi_load_initrd' Fixes: f4dc7ff ("efi: libstub: unify initrd loading between architectures") Signed-off-by: Hans Zhang <18255117159@163.com> Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
diff --git a/drivers/firmware/efi/libstub/efi-stub-helper.c b/drivers/firmware/efi/libstub/efi-stub-helper.c
@@ -601,6 +601,7 @@ efi_status_t efi_load_initrd_cmdline(efi_loaded_image_t *image,
  * @image:	EFI loaded image protocol
  * @soft_limit:	preferred address for loading the initrd
  * @hard_limit:	upper limit address for loading the initrd
+ * @out:	pointer to store the address of the initrd table
  *
  * Return:	status code
  */

Original file line number	Diff line number	Diff line change
`@@ -601,6 +601,7 @@ efi_status_t efi_load_initrd_cmdline(efi_loaded_image_t *image,`
`601`	`601`	`* @image: EFI loaded image protocol`
`602`	`602`	`* @soft_limit: preferred address for loading the initrd`
`603`	`603`	`* @hard_limit: upper limit address for loading the initrd`
	`604`	`+ * @out: pointer to store the address of the initrd table`
`604`	`605`	`*`
`605`	`606`	`* Return: status code`
`606`	`607`	`*/`