[PATCH] efi/libstub: Fix efi_set_event_at() parameter documentation

Karl Mehltretter posted 1 patch 2 weeks, 1 day ago
drivers/firmware/efi/libstub/efistub.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
[PATCH] efi/libstub: Fix efi_set_event_at() parameter documentation
Posted by Karl Mehltretter 2 weeks, 1 day ago
efi_set_event_at() documents ids although its array index argument is
named idx. This produces missing and excess parameter warnings.

Match the argument name and fix the adjacent spelling of array.

Fixes: 8c0a839c2bcc ("efi/libstub: Descriptions for stub helper functions")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 drivers/firmware/efi/libstub/efistub.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/firmware/efi/libstub/efistub.h b/drivers/firmware/efi/libstub/efistub.h
index fd91fc15ec81..049263a541ae 100644
--- a/drivers/firmware/efi/libstub/efistub.h
+++ b/drivers/firmware/efi/libstub/efistub.h
@@ -224,8 +224,8 @@ typedef void (__efiapi *efi_event_notify_t)(efi_event_t, void *);
  * efi_set_event_at() - add event to events array
  *
  * @events:	array of UEFI events
- * @ids:	index where to put the event in the array
- * @event:	event to add to the aray
+ * @idx:	index where to put the event in the array
+ * @event:	event to add to the array
  *
  * boottime->wait_for_event() takes an array of events as input.
  * Provide a helper to set it up correctly for mixed mode.

base-commit: 50d05c7c76c96b90462f24debacca971d2e86713
-- 
2.39.5 (Apple Git-154)
Re: [PATCH] efi/libstub: Fix efi_set_event_at() parameter documentation
Posted by Ard Biesheuvel 2 weeks, 1 day ago

On Thu, 10 Sep 2026, at 05:18, Karl Mehltretter wrote:
> efi_set_event_at() documents ids although its array index argument is
> named idx. This produces missing and excess parameter warnings.
>
> Match the argument name and fix the adjacent spelling of array.
>
> Fixes: 8c0a839c2bcc ("efi/libstub: Descriptions for stub helper functions")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
> ---
>  drivers/firmware/efi/libstub/efistub.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/firmware/efi/libstub/efistub.h 
> b/drivers/firmware/efi/libstub/efistub.h
> index fd91fc15ec81..049263a541ae 100644
> --- a/drivers/firmware/efi/libstub/efistub.h
> +++ b/drivers/firmware/efi/libstub/efistub.h
> @@ -224,8 +224,8 @@ typedef void (__efiapi 
> *efi_event_notify_t)(efi_event_t, void *);
>   * efi_set_event_at() - add event to events array
>   *
>   * @events:	array of UEFI events
> - * @ids:	index where to put the event in the array
> - * @event:	event to add to the aray
> + * @idx:	index where to put the event in the array
> + * @event:	event to add to the array
>   *
>   * boottime->wait_for_event() takes an array of events as input.
>   * Provide a helper to set it up correctly for mixed mode.
>

Queued up in efi/next - thanks.