linux-kernel - Re: [PATCH 12/36] tty: tty_io: Fix some kernel-doc issues

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]

Date:   Thu, 5 Nov 2020 09:16:21 +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>,
        Nick Holloway <alfie@....warwick.ac.uk>,
        -- <julian@...nix.uhcc.hawaii.edu>,
        Marko Kohtala <Marko.Kohtala@....fi>,
        Bill Hawes <whawes@...r.net>,
        "C. Scott Ananian" <cananian@...mni.princeton.edu>,
        Russell King <rmk@....linux.org.uk>,
        Andrew Morton <andrewm@....edu.eu>
Subject: Re: [PATCH 12/36] tty: tty_io: Fix some kernel-doc issues

On 04. 11. 20, 20:35, Lee Jones wrote:
> Demote non-conformant headers and supply some missing descriptions.
> 
> Fixes the following W=1 kernel build warning(s):
> 
>   drivers/tty/tty_io.c:218: warning: Function parameter or member 'file' not described in 'tty_free_file'
>   drivers/tty/tty_io.c:566: warning: Function parameter or member 'exit_session' not described in '__tty_hangup'
>   drivers/tty/tty_io.c:1077: warning: Function parameter or member 'tty' not described in 'tty_send_xchar'
>   drivers/tty/tty_io.c:1077: warning: Function parameter or member 'ch' not described in 'tty_send_xchar'
>   drivers/tty/tty_io.c:1155: warning: Function parameter or member 'file' not described in 'tty_driver_lookup_tty'
>   drivers/tty/tty_io.c:1508: warning: Function parameter or member 'tty' not described in 'release_tty'
>   drivers/tty/tty_io.c:1508: warning: Function parameter or member 'idx' not described in 'release_tty'
>   drivers/tty/tty_io.c:2973: warning: Function parameter or member 'driver' not described in 'alloc_tty_struct'
>   drivers/tty/tty_io.c:2973: warning: Function parameter or member 'idx' not described in 'alloc_tty_struct'
> 
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: Jiri Slaby <jirislaby@...nel.org>
> Cc: Nick Holloway <alfie@....warwick.ac.uk>
> Cc: -- <julian@...nix.uhcc.hawaii.edu>
> Cc: Marko Kohtala <Marko.Kohtala@....fi>
> Cc: Bill Hawes <whawes@...r.net>
> Cc: "C. Scott Ananian" <cananian@...mni.princeton.edu>
> Cc: Russell King <rmk@....linux.org.uk>
> Cc: Andrew Morton <andrewm@....edu.eu>
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
> ---
>   drivers/tty/tty_io.c | 10 +++++++---
>   1 file changed, 7 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/tty/tty_io.c b/drivers/tty/tty_io.c
> index 88b00c47b606e..f50286fb080da 100644
> --- a/drivers/tty/tty_io.c
> +++ b/drivers/tty/tty_io.c
> @@ -2961,7 +2965,7 @@ static struct device *tty_get_device(struct tty_struct *tty)
>   }
>   
>   
> -/**
> +/*
>    *	alloc_tty_struct
>    *
>    *	This subroutine allocates and initializes a tty structure.

Why do you randomly sometimes fix kernel-doc and sometimes remove 
functions from kernel-doc? What's the rule? For example, 
alloc_tty_struct is among the ones, I would like to see fixed instead of 
removed from kernel-doc.

thanks,
-- 
js
suse labs