Skip to contentSkip to conversation

efi/libstub: Add one kernel-doc comment

PATCH In review Yang Li 2 participants 2 messages Jan 19, 2024 EFI

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 efi/libstub: Add one kernel-doc comment

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'

---
 drivers/firmware/efi/libstub/alignedmem.c | 1 +
 1 file changed, 1 insertion(+)
drivers/firmware/efi/libstub/alignedmem.c +1 -0
index 6b83c492c3b8..8ff51c6a2aa1 100644
@@ -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
  *
  * 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
Signature · 1 line
2.20.1.7.g153144c
maintainer
#1 lore raw
Quoted 14 lines · Yang Li

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'

---
 drivers/firmware/efi/libstub/alignedmem.c | 1 +
 1 file changed, 1 insertion(+)
drivers/firmware/efi/libstub/alignedmem.c +0 -0
index 6b83c492c3b8..8ff51c6a2aa1 100644

drivers/firmware/efi/libstub/alignedmem.c line 17

Quoted 4 lines
drivers/firmware/efi/libstub/alignedmem.c +1 -0
@@ -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'?

Quoted 6 lines
drivers/firmware/efi/libstub/alignedmem.c +0 -1
  *
  * 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