On Wed, Jul 20, 2016 at 11:04:06AM +0200, Carlos Maiolino wrote:
> On Tue, Jul 19, 2016 at 11:18:01PM -0700, Eric Sandeen wrote:
> >
> >
> > On 7/19/16 2:15 PM, Eric Sandeen wrote:
> > > On 7/19/16 3:04 AM, Carlos Maiolino wrote:
> > >> This is the first try to document the implementation of error handlers
> > >> into
> > >> sysfs.
> > >>
> > >> Reviews and comments are appreciated, please also notice I'm not
> > >> english-native,
> > >> so, spelling corrections are also appreciated :)
> > >
> > > Thanks for doing this!
> > >
> > > There seems to be a specific sysfs documentation format, see for example
> > > Documentation/ABI/testing/sysfs-fs-ext4
> > >
> > > It might be better to follow that format, and refer to it after a brief
> > > explanation of the functionality in the xfs.txt file?
> >
> > Or not; Dave doesn't like this location, so perhaps best not to take
> > my suggestion. ;)
>
> Oh, I can see now why he doesn't like that, I've never seen such directory
> until
> you mentioned it, why should it be so hidden, and why should we split
> filesystem
> information into different locations.
>
> IMHO, if someone want to take a look into filesystem documentation, the person
> goes directly to Documentation/filesystems, I honestly think splitting
> information into two different directories are wrong, and, even though you
> point
> to there in some other place, it is still bad, sounds like a RPG book... Start
> here...now go to page X...now go to page Y...now go to page Z.
>
> I can re-format the documentation to the same format from sysfs-fs-ext4, but I
> believe keeping it under Documentation/filesystems is still the best to do. To
> be honest, I actually think we should create an XFS directory under it and put
> everything xfs related there.
I'd just add it to Doc/fs/xfs.txt right now, and we can work out
restructuring details later. Especially as we really need this documentation
added to the xfs-documentation repo (along with a "how to use"
guide). It's a similar situation to the libxfs code shared between
kernel and userspace, I think...
Cheers,
Dave.
--
Dave Chinner
david@xxxxxxxxxxxxx
|