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]

Message-ID: <adf8732b-fc01-715b-ac05-61c4c4882103@kernel.org>
Date:   Thu, 5 Nov 2020 10:14:03 +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 05. 11. 20, 9:53, Lee Jones wrote:
>> For example, alloc_tty_struct is among the
>> ones, I would like to see fixed instead of removed from kernel-doc.
> 
> There is nothing stopping anyone from providing said descriptions and
> promoting it back up to kernel-doc.  If you have good reasons for it
> to be properly documented with kernel-doc, then it should also be
> referenced from /Documentation using the kernel-doc:: notation.
> 
> Also see: scripts/find-unused-docs.sh

Thanks for this. I must admit, I haven't managed to get familiar with 
this stuff yet.

-- 
js
suse labs