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

Jiri Slaby
2020-11-05T08:12:56Z

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@linuxfoundation.org>
> Cc: Jiri Slaby <jirislaby@kernel.org>
> Signed-off-by: Lee Jones <lee.jones@linaro.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