| Message ID | 20250610000251.282760-1-rdunlap@infradead.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v2] vt: fix kernel-doc warnings in ucs_get_fallback() | expand |
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@infradead.org> > Cc: Nicolas Pitre <npitre@baylibre.com> > Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> > Cc: Jiri Slaby <jirislaby@kernel.org> > Cc: linux-serial@vger.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@baylibre.com>. > * > * Get a simpler fallback character for the provided Unicode character. > * This is used for terminal display when corresponding glyph is unavailable. >
On 6/9/25 7:19 PM, Nicolas Pitre wrote: > 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@infradead.org> >> Cc: Nicolas Pitre <npitre@baylibre.com> >> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> >> Cc: Jiri Slaby <jirislaby@kernel.org> >> Cc: linux-serial@vger.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@baylibre.com>. Sure, will do. Thanks. > >> * >> * Get a simpler fallback character for the provided Unicode character. >> * This is used for terminal display when corresponding glyph is unavailable. >>
--- 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) * * Get a simpler fallback character for the provided Unicode character. * This is used for terminal display when corresponding glyph is unavailable.
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@infradead.org> Cc: Nicolas Pitre <npitre@baylibre.com> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Jiri Slaby <jirislaby@kernel.org> Cc: linux-serial@vger.kernel.org --- v2: add Jiri and linux-serial. Mea culpa. drivers/tty/vt/ucs.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)