Re: [PATCH] vt: modify a constant prefix that looks like a ReST target
From: Randy Dunlap
Date: Wed Nov 04 2026 - 13:26:47 EST
On 11/3/26 11:17 PM, Jiri Slaby wrote:
> On 03. 11. 26, 21:39, 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.
>>
>> 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>
>> ---
>> 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
>
> Should it be also prefixed by %?
Sure, that makes the generated output look better IMO.
I'll send v2.
Thanks.
--
~Randy