linux-kernel - Re: [patch] docs, debugfs: start explicit debugfs documentation

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: <20180710064506.GA2316@kroah.com>
Date:   Tue, 10 Jul 2018 08:45:06 +0200
From:   Greg KH <gregkh@...uxfoundation.org>
To:     David Rientjes <rientjes@...gle.com>
Cc:     Andrew Morton <akpm@...ux-foundation.org>,
        "Rafael J. Wysocki" <rafael@...nel.org>,
        Jonathan Corbet <corbet@....net>,
        Randy Dunlap <rdunlap@...radead.org>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [patch] docs, debugfs: start explicit debugfs documentation

On Mon, Jul 09, 2018 at 03:00:17PM -0700, David Rientjes wrote:
> There is no canonical location for debugfs docuemntation, so start one.
> 
> This is primarily motivated to describe the oom_free_timeout_ms interface
> but it is extended for all the debugfs files that I am personally
> interested in.
> 
> Hopefully this can be expanded in the future for better insight into how
> the various interfaces can be used.
> 
> Suggested-by: Andrew Morton <akpm@...ux-foundation.org>
> Signed-off-by: David Rientjes <rientjes@...gle.com>
> ---
>  Documentation/clearing-warn-once.txt       |   7 --
>  Documentation/debugfs/00-INDEX             |   8 ++
>  Documentation/debugfs/extfrag.txt          |  46 +++++++
>  Documentation/debugfs/provoke-crashes.txt  |   8 ++
>  Documentation/debugfs/root.txt             | 137 +++++++++++++++++++++
>  Documentation/filesystems/debugfs.txt      |  46 +++++++
>  Documentation/power/basic-pm-debugging.txt |  25 +---
>  Documentation/sysctl/vm.txt                |   7 +-

This is a mix of a lot of different things all at once.

I'll gladly take the update to the debugfs.txt file for the newer api
calls as a separate file.

For the "this is what a specific debugfs file contains", those should go
into Documenation/ABI/ if you really want to document those types of
things.

But as it is, this single patch does too many different things all at
once.

thanks,

greg k-h