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 <s...@chromium.org>
Suggested-by: Heinrich Schuchardt <xypron.g...@gmx.de>
---
(no changes since v3)
Changes in v3:
- Put the header-file in its own section
Changes in v2:
- Add new patch to add the EFI-loader API documentation
doc/api/efi.rst | 6 ++++++
include/efi_loader.h | 2 +-
2 files changed, 7 insertions(+), 1 deletion(-)
diff --git a/doc/api/efi.rst b/doc/api/efi.rst
index 43d6f936fb0..49814bcf5ea 100644
--- a/doc/api/efi.rst
+++ b/doc/api/efi.rst
@@ -54,6 +54,12 @@ drivers, handles, loaded images, and the memory map).
.. kernel-doc:: cmd/efidebug.c
:internal:
+Overall API
+-----------
+
+.. kernel-doc:: include/efi_loader.h
+ :internal:
+
Initialization of the UEFI sub-system
-------------------------------------
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.43.0
