linux-kernel - Re: [PATCH v2] vt: fix kernel-doc warnings in ucs_get

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <6rr665sp-3q45-66q8-snso-5071q34q71pr@onlyvoer.pbz>
Date: Mon, 9 Jun 2025 22:19:07 -0400 (EDT)
From: Nicolas Pitre <npitre@...libre.com>
To: Randy Dunlap <rdunlap@...radead.org>
cc: linux-kernel@...r.kernel.org, 
    Greg Kroah-Hartman <gregkh@...uxfoundation.org>, 
    Jiri Slaby <jirislaby@...nel.org>, linux-serial@...r.kernel.org
Subject: Re: [PATCH v2] vt: fix kernel-doc warnings in ucs_get_fallback()

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@...radead.org>
> Cc: Nicolas Pitre <npitre@...libre.com>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: Jiri Slaby <jirislaby@...nel.org>
> Cc: linux-serial@...r.kernel.org
> ---
> 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@...libre.com>.

>   *
>   * Get a simpler fallback character for the provided Unicode character.
>   * This is used for terminal display when corresponding glyph is unavailable.
>