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

[Greg KH <gregkh@linuxfoundation.org>]

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