Subject: Re: Documenting filesystem kernel options outside of options(4)
To: Magnus Eriksson <magetoo@fastmail.fm>
From: Julio M. Merino Vidal <jmmv84@gmail.com>
List: tech-kern
Date: 03/11/2006 16:49:47
On Friday 10 March 2006 11:37, Magnus Eriksson wrote:
> On Thu, 9 Mar 2006, Michael-John Turner wrote:
> > Two options:
> > 1 - Include the required/optional kernel options (and only the kernel
> >    options) in the respective mount*.8 manual pages.
> > 2 - Create a section 4 manual page for each filesystem type (ffs.4,
> > 	 cd9660.4, smbfs.4, etc), explaining in more detail what its for,
> >    certain key data structures, required and optional kernel options,
> >    etc (much like raid.4). The various mount*.8 could then refer to
> >    the *.4 for the particular filesystem.
>
> [...]
>
> > Any thoughts on this? Is it worthwhile creating such filesystem manual
> > pages or documenting the kernel options in each mount* manpage (or both)?
> > Should I rather spend my time on something more useful? :)
>
> This user thinks that having real live manpages for the file systems would
> be Really Nice.  Looking in mount_<foo> seems counterintuitive, and the
> file systems themselves aren't really described in depth at all now (are
> they?).

I also think that these pages should exist and that they could be very
valuable.

But they should only detail the "public" interface of the file system;
i.e., kernel options, the mount arguments structure, in which scenarios it
is useful, etc.

-- 
Julio M. Merino Vidal <jmmv84@gmail.com>
The Julipedia - http://julipedia.blogspot.com/