Re: [PATCH 1/5] efi/libstub: Make efi_remap_image() return efi_status_t

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential
issue to consider:
- [Low] efi/libstub: missing Return: section in efi_remap_image()
  kernel-doc
--

commit 87d3e561f50dd1226f0d061af43fd4aa4ab0ee9c
Author: Ard Biesheuvel <ardb@kernel.org>

efi/libstub: Make efi_remap_image() return efi_status_t

This commit changes efi_remap_image() to return an efi_status_t so callers
are notified if remapping code or data regions via the EFI Memory
Attributes Protocol fails.

> diff --git a/drivers/firmware/efi/libstub/efi-stub-helper.c b/drivers/firmware/efi/libstub/efi-stub-helper.c
> index 8e43eb3f418b1..b2ad081cf324c 100644
> --- a/drivers/firmware/efi/libstub/efi-stub-helper.c
> +++ b/drivers/firmware/efi/libstub/efi-stub-helper.c
> @@ -698,8 +698,8 @@ efi_status_t efi_wait_for_key(unsigned long usec, efi_input_key_t *key)
>   * read-write/non-executable. The code region is assumed to start at the base
>   * of the image, and will therefore cover the PE/COFF header as well.
>   */
> -void efi_remap_image(unsigned long image_base, unsigned alloc_size,
> -		     unsigned long code_size)
> +efi_status_t efi_remap_image(unsigned long image_base, unsigned alloc_size,
> +			     unsigned long code_size)

[Severity: Low]
This isn't a bug, but now that efi_remap_image() returns efi_status_t
instead of void, the preceding kernel-doc comment needs a Return: section
to avoid a kernel-doc -Wreturn warning (make W=2).

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261106141936.2744481-7-ardb+git@google.com?part=1