linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Greg KH <gregkh@linuxfoundation.org>
To: David Rientjes <rientjes@google.com>
Cc: Andrew Morton <akpm@linux-foundation.org>,
	"Rafael J. Wysocki" <rafael@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Randy Dunlap <rdunlap@infradead.org>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [patch] docs, debugfs: start explicit debugfs documentation
Date: Tue, 10 Jul 2018 08:45:06 +0200	[thread overview]
Message-ID: <20180710064506.GA2316@kroah.com> (raw)
In-Reply-To: <alpine.DEB.2.21.1807091459410.118937@chino.kir.corp.google.com>

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@linux-foundation.org>
> Signed-off-by: David Rientjes <rientjes@google.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
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

  parent reply	other threads:[~2018-07-10  6:45 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-09 22:00 [patch] docs, debugfs: start explicit debugfs documentation David Rientjes
2018-07-09 22:12 ` Andrew Morton
2018-07-10  6:42   ` Greg Kroah-Hartman
2018-07-10  6:45 ` Greg KH [this message]
2018-07-10 11:28   ` Jonathan Corbet
2018-07-10 11:46     ` Greg KH

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180710064506.GA2316@kroah.com \
    --to=gregkh@linuxfoundation.org \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rafael@kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=rientjes@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).