[PATCH] vt: fix comment vs definition mismatch

[Nicolas Pitre]

From: Nicolas Pitre <npitre@xxxxxxxxxxxx>

Fixes for:

  ucs_is_zero_width()
  ucs_is_double_width()
  ucs_recompose()

Signed-off-by: Nicolas Pitre <npitre@xxxxxxxxxxxx>
Reported-by: kernel test robot <lkp@xxxxxxxxx>
Closes: https://lore.kernel.org/oe-kbuild-all/202504111036.YH1iEqBR-lkp@xxxxxxxxx/
Closes: https://lore.kernel.org/oe-kbuild-all/202504111359.urXWyzvQ-lkp@xxxxxxxxx/
---

On Fri, 11 Apr 2025, Greg Kroah-Hartman wrote:

> Wow, very nice work, thanks for doing all of this.  I'll go queue it up
> now, the kernel test robot warnings for comments can be fixed up later
> if you want to.

Oops. Here it is.

diff --git a/drivers/tty/vt/gen_ucs_recompose.py b/drivers/tty/vt/gen_ucs_recompose.py
index 64418803e4..dc176d32e2 100755
--- a/drivers/tty/vt/gen_ucs_recompose.py
+++ b/drivers/tty/vt/gen_ucs_recompose.py
@@ -289,8 +289,8 @@ static int recomposition_compare(const void *key, const void *element)
 /**
  * Attempt to recompose two Unicode characters into a single character.
  *
- * @param previous: Previous Unicode code point (UCS-4)
- * @param current: Current Unicode code point (UCS-4)
+ * @param base: Base Unicode code point (UCS-4)
+ * @param combining: Combining mark Unicode code point (UCS-4)
  * Return: Recomposed Unicode code point, or 0 if no recomposition is possible
  */
 uint32_t ucs_recompose(uint32_t base, uint32_t combining)
@@ -301,7 +301,6 @@ uint32_t ucs_recompose(uint32_t base, uint32_t combining)
 		return 0;
 
 	struct compare_key key = {{ base, combining }};
-
 	struct recomposition *result =
 		__inline_bsearch(&key, recomposition_table,
 				 ARRAY_SIZE(recomposition_table),
diff --git a/drivers/tty/vt/gen_ucs_width.py b/drivers/tty/vt/gen_ucs_width.py
index c6cbc93e83..e65f43e208 100755
--- a/drivers/tty/vt/gen_ucs_width.py
+++ b/drivers/tty/vt/gen_ucs_width.py
@@ -292,7 +292,7 @@ static bool is_in_interval32(uint32_t cp, const struct interval32 *intervals, si
 /**
  * Determine if a Unicode code point is zero-width.
  *
- * @param ucs: Unicode code point (UCS-4)
+ * @param cp: Unicode code point (UCS-4)
  * Return: true if the character is zero-width, false otherwise
  */
 bool ucs_is_zero_width(uint32_t cp)
@@ -305,7 +305,7 @@ bool ucs_is_zero_width(uint32_t cp)
 /**
  * Determine if a Unicode code point is double-width.
  *
- * @param ucs: Unicode code point (UCS-4)
+ * @param cp: Unicode code point (UCS-4)
  * Return: true if the character is double-width, false otherwise
  */
 bool ucs_is_double_width(uint32_t cp)
diff --git a/drivers/tty/vt/ucs_recompose.c b/drivers/tty/vt/ucs_recompose.c
index 5c30c989de..52cde1517f 100644
--- a/drivers/tty/vt/ucs_recompose.c
+++ b/drivers/tty/vt/ucs_recompose.c
@@ -147,8 +147,8 @@ static int recomposition_compare(const void *key, const void *element)
 /**
  * Attempt to recompose two Unicode characters into a single character.
  *
- * @param previous: Previous Unicode code point (UCS-4)
- * @param current: Current Unicode code point (UCS-4)
+ * @param base: Base Unicode code point (UCS-4)
+ * @param combining: Combining mark Unicode code point (UCS-4)
  * Return: Recomposed Unicode code point, or 0 if no recomposition is possible
  */
 uint32_t ucs_recompose(uint32_t base, uint32_t combining)
@@ -159,7 +159,6 @@ uint32_t ucs_recompose(uint32_t base, uint32_t combining)
 		return 0;
 
 	struct compare_key key = { base, combining };
-
 	struct recomposition *result =
 		__inline_bsearch(&key, recomposition_table,
 				 ARRAY_SIZE(recomposition_table),
diff --git a/drivers/tty/vt/ucs_width.c b/drivers/tty/vt/ucs_width.c
index 060aa8ae7f..4d5a0021e3 100644
--- a/drivers/tty/vt/ucs_width.c
+++ b/drivers/tty/vt/ucs_width.c
@@ -512,7 +512,7 @@ static bool is_in_interval32(uint32_t cp, const struct interval32 *intervals, si
 /**
  * Determine if a Unicode code point is zero-width.
  *
- * @param ucs: Unicode code point (UCS-4)
+ * @param cp: Unicode code point (UCS-4)
  * Return: true if the character is zero-width, false otherwise
  */
 bool ucs_is_zero_width(uint32_t cp)
@@ -525,7 +525,7 @@ bool ucs_is_zero_width(uint32_t cp)
 /**
  * Determine if a Unicode code point is double-width.
  *
- * @param ucs: Unicode code point (UCS-4)
+ * @param cp: Unicode code point (UCS-4)
  * Return: true if the character is double-width, false otherwise
  */
 bool ucs_is_double_width(uint32_t cp)