Re: [PATCH v2] vt: modify a constant prefix that looks like a ReST target
From: Randy Dunlap
Date: Tue Nov 17 2026 - 19:15:42 EST
ping?
On 11/4/26 10:22 AM, Randy Dunlap wrote:
> Use CUR_* (could also be something like CUR_x) instead of just "CUR_"
> because the ending '_' indicates a documentation target name, so
> unconfuse the name.
> Precede it with '%' to indicate that it is a constant.
>
> Prevents these warnings:
>
> Documentation/driver-api/tty/console:36: drivers/tty/vt/vt.c:275: ERROR: Unknown target name: "cur". [docutils]
> Documentation/driver-api/tty/console:36: drivers/tty/vt/vt.c:317: ERROR: Unknown target name: "cur". [docutils]
> Documentation/driver-api/tty/console:36: drivers/tty/vt/vt.c:353: ERROR: Unknown target name: "cur". [docutils]
>
> Fixes: 1438d00569c4 ("vt: Add cursor-size helpers")
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> ---
> v2: Precede "CUR_*" with a '%' to indicate constant. (Jiri)
>
> Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
> Cc: Jiri Slaby <jirislaby@xxxxxxxxxx>
> Cc: linux-kernel@xxxxxxxxxxxxxxx
> Cc: linux-serial@xxxxxxxxxxxxxxx
> Cc: Thomas Zimmermann <tzimmermann@xxxxxxx>
> Cc: Helge Deller <deller@xxxxxx>
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Cc: Shuah Khan <skhan@xxxxxxxxxxxxxxxxxxx>
> Cc: linux-doc@xxxxxxxxxxxxxxx
>
> drivers/tty/vt/vt.c | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> --- linux-next-20261102.orig/drivers/tty/vt/vt.c
> +++ linux-next-20261102/drivers/tty/vt/vt.c
> @@ -273,7 +273,7 @@ EXPORT_SYMBOL_GPL(vc_font_size);
> * vc_cursor_valid_size - Computes a valid cursor size from the given value
> * @cursor_size: The size constant of cursor pattern
> *
> - * The argument given in @cursor_size is one of the CUR_ constants, as stored
> + * The argument given in @cursor_size is one of the %CUR_* constants, as stored
> * in struct @vc_data.vc_cursor_type. For unknown values, the helper draws the
> * default cursor or an underline dash.
> *
> @@ -317,7 +317,7 @@ EXPORT_SYMBOL_GPL(vc_cursor_valid_size);
> *
> * The parameter @cell_height is the height of the character cell as
> * displayed by the console. The argument given in @cursor_size is one
> - * of the CUR_ constants. See vc_cursor_valid_size() for how to get a
> + * of the %CUR_* constants. See vc_cursor_valid_size() for how to get a
> * valid cursor-size constant.
> *
> * Returns:
> @@ -353,7 +353,7 @@ EXPORT_SYMBOL_GPL(vc_cursor_start);
> *
> * The parameter @cell_height is the height of the character cell as
> * displayed by the console. The argument given in @cursor_size is one
> - * of the CUR_ constants. See vc_cursor_valid_size() for how to get a
> + * of the %CUR_* constants. See vc_cursor_valid_size() for how to get a
> * valid cursor-size constant.
> *
> * Returns:
>
--
~Randy