Re: [PATCH -next] efi/libstub: Add one kernel-doc comment

[Ard Biesheuvel]

On Fri, 19 Jan 2024 at 11:06, Yang Li <yang.lee@xxxxxxxxxxxxxxxxx> wrote:
>
> Add the description of @memory_type to silence the warning:
> drivers/firmware/efi/libstub/alignedmem.c:27: warning: Function parameter or struct member 'memory_type' not described in 'efi_allocate_pages_aligned'
>
> Signed-off-by: Yang Li <yang.lee@xxxxxxxxxxxxxxxxx>
> ---
>  drivers/firmware/efi/libstub/alignedmem.c | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/drivers/firmware/efi/libstub/alignedmem.c b/drivers/firmware/efi/libstub/alignedmem.c
> index 6b83c492c3b8..8ff51c6a2aa1 100644
> --- a/drivers/firmware/efi/libstub/alignedmem.c
> +++ b/drivers/firmware/efi/libstub/alignedmem.c
> @@ -14,6 +14,7 @@
>   * @max:       the address that the last allocated memory page shall not
>   *             exceed
>   * @align:     minimum alignment of the base of the allocation
> + * @memory_type: the type of memory to allocate, as defined by efi_memory_type

What is 'efi_memory_type'?

>   *
>   * Allocate pages as EFI_LOADER_DATA. The allocated pages are aligned according
>   * to @align, which should be >= EFI_ALLOC_ALIGN. The last allocated page will
> --
> 2.20.1.7.g153144c
>