efi_loader: document parameters of do_bootefi_exec()
authorHeinrich Schuchardt <xypron.glpk@gmx.de>
Sat, 15 Aug 2020 21:10:22 +0000 (23:10 +0200)
committerHeinrich Schuchardt <xypron.glpk@gmx.de>
Mon, 24 Aug 2020 14:37:53 +0000 (16:37 +0200)
Add the missing description of the load_options parameter.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
cmd/bootefi.c

index fbfed54..06563d2 100644 (file)
@@ -304,7 +304,11 @@ efi_status_t efi_install_fdt(void *fdt)
 /**
  * do_bootefi_exec() - execute EFI binary
  *
+ * The image indicated by @handle is started. When it returns the allocated
+ * memory for the @load_options is freed.
+ *
  * @handle:            handle of loaded image
+ * @load_options:      load options
  * Return:             status code
  *
  * Load the EFI binary into a newly assigned memory unwinding the relocation