linux-kernel - Re: [PATCH 08/36] tty: tty_ldisc: Fix some kernel-doc related misdemeanours

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <8f07fa1e-d81f-fd43-9dfa-bfb9f9171619@kernel.org>
Date:   Thu, 5 Nov 2020 09:12:48 +0100
From:   Jiri Slaby <jirislaby@...nel.org>
To:     Lee Jones <lee.jones@...aro.org>
Cc:     linux-kernel@...r.kernel.org,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Subject: Re: [PATCH 08/36] tty: tty_ldisc: Fix some kernel-doc related
 misdemeanours

On 04. 11. 20, 20:35, Lee Jones wrote:
>   - Functions must follow directly on from their headers
>   - Demote non-conforming kernel-doc header
>   - Ensure notes have unique section names
>   - Provide missing description for 'reinit'
> 
> Fixes the following W=1 kernel build warning(s):
> 
>   drivers/tty/tty_ldisc.c:158: warning: cannot understand function prototype: 'int tty_ldisc_autoload = IS_BUILTIN(CONFIG_LDISC_AUTOLOAD); '
>   drivers/tty/tty_ldisc.c:199: warning: Function parameter or member 'ld' not described in 'tty_ldisc_put'
>   drivers/tty/tty_ldisc.c:260: warning: duplicate section name 'Note'
>   drivers/tty/tty_ldisc.c:717: warning: Function parameter or member 'reinit' not described in 'tty_ldisc_hangup'
> 
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: Jiri Slaby <jirislaby@...nel.org>
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
> ---
>   drivers/tty/tty_ldisc.c | 10 +++++-----
>   1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/tty/tty_ldisc.c b/drivers/tty/tty_ldisc.c
> index fe37ec331289b..aced2bf6173be 100644
> --- a/drivers/tty/tty_ldisc.c
> +++ b/drivers/tty/tty_ldisc.c
> @@ -190,7 +189,7 @@ static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
>   	return ld;
>   }
>   
> -/**
> +/*
>    *	tty_ldisc_put		-	release the ldisc

Having tty_ldisc_get in kernel-doc, while tty_ldisc_put not doesn't make 
much sense. What's missing to tty_ldisc_put to conform to kernel-doc?

thanks,
-- 
js
suse labs