]> www.infradead.org Git - users/hch/misc.git/commitdiff
efi/libstub: Describe missing 'out' parameter in efi_load_initrd
authorHans Zhang <18255117159@163.com>
Tue, 6 May 2025 16:31:11 +0000 (00:31 +0800)
committerArd Biesheuvel <ardb@kernel.org>
Fri, 9 May 2025 09:24:00 +0000 (11:24 +0200)
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: f4dc7fffa987 ("efi: libstub: unify initrd loading between architectures")
Signed-off-by: Hans Zhang <18255117159@163.com>
Signed-off-by: Ard Biesheuvel <ardb@kernel.org>
drivers/firmware/efi/libstub/efi-stub-helper.c

index fd6dc790c5a89d93f365739fe3f6fccb009655da..7aa2f9ad2935627b3eff4fd48f42942f6d93d75b 100644 (file)
@@ -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
  */