[PATCH v2 08/28] doc: efi: Add the EFI-loader API documentation
Simon Glass
sjg at chromium.org
Thu Nov 28 16:47:07 CET 2024
Bring in the documentation from the efi_loader.h header file, so we can
see the API defined there.
Fix efi_alloc() to avoid a warning.
Signed-off-by: Simon Glass <sjg at chromium.org>
Suggested-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
---
Changes in v2:
- Add new patch to add the EFI-loader API documentation
doc/api/efi.rst | 3 +++
include/efi_loader.h | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/doc/api/efi.rst b/doc/api/efi.rst
index 43d6f936fb0..57da7f615a6 100644
--- a/doc/api/efi.rst
+++ b/doc/api/efi.rst
@@ -75,6 +75,9 @@ Image relocation
Memory services
~~~~~~~~~~~~~~~
+.. kernel-doc:: include/efi_loader.h
+ :internal:
+
.. kernel-doc:: lib/efi_loader/efi_memory.c
:internal:
diff --git a/include/efi_loader.h b/include/efi_loader.h
index 00a1259c006..3f75f2efcb6 100644
--- a/include/efi_loader.h
+++ b/include/efi_loader.h
@@ -764,7 +764,7 @@ efi_status_t efi_next_variable_name(efi_uintn_t *size, u16 **buf,
*
* Allocate memory from pool and zero it out.
*
- * @size: number of bytes to allocate
+ * @len: number of bytes to allocate
* Return: pointer to allocated memory or NULL
*/
void *efi_alloc(size_t len);
--
2.34.1
More information about the U-Boot
mailing list