From: Greg KH <gregkh@linuxfoundation.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: David Rientjes <rientjes@google.com>,
Andrew Morton <akpm@linux-foundation.org>,
"Rafael J. Wysocki" <rafael@kernel.org>,
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 13:46:24 +0200 [thread overview]
Message-ID: <20180710114624.GA14261@kroah.com> (raw)
In-Reply-To: <20180710052835.581cdf28@lwn.net>
On Tue, Jul 10, 2018 at 05:28:35AM -0600, Jonathan Corbet wrote:
> On Tue, 10 Jul 2018 08:45:06 +0200
> Greg KH <gregkh@linuxfoundation.org> wrote:
>
> > 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.
>
> Do we really want to start populating Documentation/ABI with stuff that's
> explicitly *not* ABI? Keeping it separate might make more sense, IMO.
> I'd put extfrag_index with the MM docs, for example.
I personally don't think that debugfs files should be documented
anywhere, unless it makes sense from a "help debug the kernel" point of
view. And yes, you are right, we don't want to document things in /ABI/
that are not ABI stuff, as debugfs files can, and do, change at random
times.
Putting the info in the subsystem specific documents makes sense.
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
prev parent reply other threads:[~2018-07-10 11:46 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
2018-07-10 11:28 ` Jonathan Corbet
2018-07-10 11:46 ` Greg KH [this message]
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=20180710114624.GA14261@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).