Re: [PATCH v2 46/47] tty: vt: fix up kernel-doc

From: Randy Dunlap
Date: Mon Jan 22 2024 - 23:17:09 EST




On 1/22/24 03:04, Jiri Slaby (SUSE) wrote:
> selection.c and vt.c still uses tabs in the kernel-doc. This misrenders the
> functions in the output -- sphinx misinterprets the description. So
> remove these tabs, incl. those around dashes.
>
> 'enum' keyword is needed before enum names. Fix that.
>
> Superfluous \n after the comments are also removed. They are not
> completely faulty, but this unifies all the kernel-doc in the files.
>
> Finally fix up the cross references.
>
> Signed-off-by: Jiri Slaby (SUSE) <jirislaby@xxxxxxxxxx>


Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

> ---
> drivers/tty/vt/selection.c | 30 ++++++-------
> drivers/tty/vt/vt.c | 86 +++++++++++++++++++-------------------
> include/linux/console.h | 6 +--
> 3 files changed, 62 insertions(+), 60 deletions(-)
>

--
#Randy