[PATCH] vt: modify a constant prefix that looks like a ReST target

[PATCH] vt: modify a constant prefix that looks like a ReST target

[Randy Dunlap]

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@infradead.org>
---
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jiri Slaby <jirislaby@kernel.org>
Cc: linux-kernel@vger.kernel.org
Cc: linux-serial@vger.kernel.org
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Helge Deller <deller@gmx.de>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org

 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:

Re: [PATCH] vt: modify a constant prefix that looks like a ReST target

[Jiri Slaby]

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@infradead.org>
> ---
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: Jiri Slaby <jirislaby@kernel.org>
> Cc: linux-kernel@vger.kernel.org
> Cc: linux-serial@vger.kernel.org
> Cc: Thomas Zimmermann <tzimmermann@suse.de>
> Cc: Helge Deller <deller@gmx.de>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
> 
>   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 %?

thanks,
-- 
js
suse labs

Re: [PATCH] vt: modify a constant prefix that looks like a ReST target

[Randy Dunlap]

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@infradead.org>
>> ---
>> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
>> Cc: Jiri Slaby <jirislaby@kernel.org>
>> Cc: linux-kernel@vger.kernel.org
>> Cc: linux-serial@vger.kernel.org
>> Cc: Thomas Zimmermann <tzimmermann@suse.de>
>> Cc: Helge Deller <deller@gmx.de>
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: Shuah Khan <skhan@linuxfoundation.org>
>> Cc: linux-doc@vger.kernel.org
>>
>>   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