Re: [PATCH] efi/libstub: Describe missing 'out' parameter in efi_load_initrd

[Ard Biesheuvel]

On Tue, 6 May 2025 at 18:31, Hans Zhang <18255117159@xxxxxxx> wrote:
>
> 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@xxxxxxx>

Queued in efi/next - thanks.

> ---
>  drivers/firmware/efi/libstub/efi-stub-helper.c | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/drivers/firmware/efi/libstub/efi-stub-helper.c b/drivers/firmware/efi/libstub/efi-stub-helper.c
> index fd6dc790c5a8..7aa2f9ad2935 100644
> --- 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
>   */
>
> base-commit: 01f95500a162fca88cefab9ed64ceded5afabc12
> --
> 2.25.1
>