Re: [PATCH v2] vt: fix kernel-doc warnings in ucs_get_fallback()
From: Nicolas Pitre
Date: Mon Jun 09 2025 - 22:19:24 EST
On Mon, 9 Jun 2025, Randy Dunlap wrote:
> Use the correct function parameter name in ucs_get_fallback() to prevent
> kernel-doc warnings:
>
> Warning: drivers/tty/vt/ucs.c:218 function parameter 'cp' not described in 'ucs_get_fallback'
> Warning: drivers/tty/vt/ucs.c:218 Excess function parameter 'base' description in 'ucs_get_fallback'
>
> Fixes: fe26933cf1e1 ("vt: add ucs_get_fallback()")
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Nicolas Pitre <npitre@xxxxxxxxxxxx>
> Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
> Cc: Jiri Slaby <jirislaby@xxxxxxxxxx>
> Cc: linux-serial@xxxxxxxxxxxxxxx
> ---
> v2: add Jiri and linux-serial. Mea culpa.
>
> drivers/tty/vt/ucs.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- lnx-616-rc1.orig/drivers/tty/vt/ucs.c
> +++ lnx-616-rc1/drivers/tty/vt/ucs.c
> @@ -206,7 +206,7 @@ static int ucs_page_entry_cmp(const void
>
> /**
> * ucs_get_fallback() - Get a substitution for the provided Unicode character
> - * @base: Base Unicode code point (UCS-4)
> + * @cp: Base Unicode code point (UCS-4)
Please delete the "Base" word from the definition as well.
Then you can add Reviewed-by: Nicolas Pitre <npitre@xxxxxxxxxxxx>.
> *
> * Get a simpler fallback character for the provided Unicode character.
> * This is used for terminal display when corresponding glyph is unavailable.
>