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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <3ce78854-e941-47e5-933e-38b18d5203d9@infradead.org>
Date: Mon, 22 Jan 2024 20:16:49 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: "Jiri Slaby (SUSE)" <jirislaby@...nel.org>, gregkh@...uxfoundation.org
Cc: linux-serial@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 46/47] tty: vt: fix up kernel-doc



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@...nel.org>


Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

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