Re: [patch] docs, debugfs: start explicit debugfs documentation

From: Greg KH
Date: Tue Jul 10 2018 - 02:45:15 EST


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@xxxxxxxxxxxxxxxxxxxx>
> Signed-off-by: David Rientjes <rientjes@xxxxxxxxxx>
> ---
> 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