svn commit: r266972 - head/sbin/geom/class/label

[John-Mark Gurney]

Ivan Voras wrote this message on Tue, Jun 03, 2014 at 21:31 +0200:
> None of the other classes have the sysctls documented here, there's
> only a description of the kern.geom.label.debug flag.

That's probably because people haven't spent much time documenting
their code...  Just because other classes have bad documentation
doesn't mean glabel should have bad docs...

If you don't want to document the sysctl's on glabel(8), another
option is to create a new page, glabel(9), xref it on glabel(8) and
document it there, but that seems excesive, unless you need to
document more specific kernel features of glabel...  Plus, it'd make
it harder for users to track down..

> I guess adding a wildcard catch-all section for the
> kern.geom.label.*.enable would be best here.

Yes, that would be useful, even just mentioning the sysctl tree is
good...  And since we've started adding descriptions to your sysctls,
they are somewhat self documenting now, just need to know that they
exist...

Thanks.

> On 3 June 2014 00:31, John-Mark Gurney <jmg at funkthat.com> wrote:
> > Ivan Voras wrote this message on Mon, Jun 02, 2014 at 15:05 +0000:
> >> Author: ivoras
> >> Date: Mon Jun  2 15:05:25 2014
> >> New Revision: 266972
> >> URL: http://svnweb.freebsd.org/changeset/base/266972
> >>
> >> Log:
> >>   Document the diskid automatic label class.
> >>   While there, also document the glabel "native" labels and explain why
> >>   there are additional nodes created for nested GEOM classes.
> >>
> >>   Reminded by:        jmg
> >
> > Shouldn't kern.geom.label.disk_ident.enable also be documented here?

-- 
  John-Mark Gurney				Voice: +1 415 225 5579

     "All that I will do, has been done, All that I have, has not."