[PATCH 1/1] efi_loader: fix some function descriptions

[Ilias Apalodimas]

On Thu, 19 Sept 2024 at 00:37, Heinrich Schuchardt
<heinrich.schuchardt at canonical.com> wrote:
>
> * The function name must be provided in the description.
> * The function name must match the name used in the description.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
> ---
> @Tom
> This is one of the fixes needed before we can update scripts/kernel-doc.
> ---
>  lib/efi_loader/efi_console.c           | 2 +-
>  lib/efi_loader/efi_file.c              | 2 +-
>  lib/efi_loader/efi_rng.c               | 2 +-
>  lib/efi_loader/efi_unicode_collation.c | 2 +-
>  4 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/lib/efi_loader/efi_console.c b/lib/efi_loader/efi_console.c
> index cea50c748aa..9d9f786a6db 100644
> --- a/lib/efi_loader/efi_console.c
> +++ b/lib/efi_loader/efi_console.c
> @@ -100,7 +100,7 @@ static int term_get_char(s32 *c)
>  }
>
>  /**
> - * Receive and parse a reply from the terminal.
> + * term_read_reply() - receive and parse a reply from the terminal
>   *
>   * @n:         array of return values
>   * @num:       number of return values expected
> diff --git a/lib/efi_loader/efi_file.c b/lib/efi_loader/efi_file.c
> index 222001d6a3b..c92d8ccf004 100644
> --- a/lib/efi_loader/efi_file.c
> +++ b/lib/efi_loader/efi_file.c
> @@ -295,7 +295,7 @@ out:
>  }
>
>  /**
> - * efi_file_open_()
> + * efi_file_open() - open file synchronously
>   *
>   * This function implements the Open service of the File Protocol.
>   * See the UEFI spec for details.
> diff --git a/lib/efi_loader/efi_rng.c b/lib/efi_loader/efi_rng.c
> index 9bad7ed6931..4734f95eee1 100644
> --- a/lib/efi_loader/efi_rng.c
> +++ b/lib/efi_loader/efi_rng.c
> @@ -91,7 +91,7 @@ back:
>  }
>
>  /**
> - * rng_getrng() - get random value
> + * getrng() - get random value
>   *
>   * This function implement the GetRng() service of the EFI random number
>   * generator protocol. See the UEFI spec for details.
> diff --git a/lib/efi_loader/efi_unicode_collation.c b/lib/efi_loader/efi_unicode_collation.c
> index 627bb9123cf..d48700a352b 100644
> --- a/lib/efi_loader/efi_unicode_collation.c
> +++ b/lib/efi_loader/efi_unicode_collation.c
> @@ -266,7 +266,7 @@ static void EFIAPI efi_fat_to_str(struct efi_unicode_collation_protocol *this,
>  }
>
>  /**
> - * efi_fat_to_str() - convert a utf-16 string to legal characters for a FAT
> + * efi_str_to_fat() - convert a utf-16 string to legal characters for a FAT
>   *                    file name in an OEM code page
>   *
>   * @this:      unicode collation protocol instance
> --
> 2.45.2
>

Reviewed-by: Ilias Apalodimas <ilias.apalodimas at linaro.org>