tty/vt: Corrected doc of vc_sanitize_unicode(), vc_translate_unicode()
authorRoman Žilka <roman.zilka@gmail.com>
Sun, 11 Feb 2024 15:51:04 +0000 (16:51 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Sat, 17 Feb 2024 16:44:46 +0000 (17:44 +0100)
commit8524788abf564fb7927873ff3fbc8056c6f02195
treee5efba786cf3c728198632192dd6bab32a7b6af6
parent6cc3028f797a549f256d593867a769ab6a8265f2
tty/vt: Corrected doc of vc_sanitize_unicode(), vc_translate_unicode()

Corrected the doc of vc_sanitize_unicode() and vc_translate_unicode(),
tightly coupled functions which parse UTF-8 byte sequences.
1. Desc. of @rescan corresponded to the meaning of the return value -1.
   Corrected + added "Return:" section.
2. Replaced the ambiguous "character" with "code point" or "byte".

Signed-off-by: Roman Žilka <roman.zilka@gmail.com>
Link: https://lore.kernel.org/r/bee9faa8-0ea7-4411-bf77-3cb2e06385c7@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/tty/vt/vt.c