docs/98801: gmirror(8) and glabel(8) manpages should mention geom_{mirror, label}_load

[Christian Brueffer]

The following reply was made to PR docs/98801; it has been noted by GNATS.

From: Christian Brueffer <brueffer at FreeBSD.org>
To: Peter Schuller <peter.schuller at infidyne.com>
Cc: FreeBSD-gnats-submit at FreeBSD.org
Subject: Re: docs/98801: gmirror(8) and glabel(8) manpages should mention
 geom_{mirror, label}_load
Date: Sun, 11 Jun 2006 13:49:50 +0200

 --WIyZ46R2i8wDzkSu
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: inline
 Content-Transfer-Encoding: quoted-printable
 
 On Sun, Jun 11, 2006 at 01:12:59PM +0200, Peter Schuller wrote:
 >=20
 > >Number:         98801
 > >Category:       docs
 > >Synopsis:       gmirror(8) and glabel(8) manpages should mention geom_{m=
 irror,label}_load
 > >Confidential:   no
 > >Severity:       non-critical
 > >Priority:       medium
 > >Responsible:    freebsd-doc
 > >State:          open
 > >Quarter:       =20
 > >Keywords:      =20
 > >Date-Required:
 > >Class:          change-request
 > >Submitter-Id:   current-users
 > >Arrival-Date:   Sun Jun 11 11:20:17 GMT 2006
 > >Closed-Date:
 > >Last-Modified:
 > >Originator:     Peter Schuller <peter.schuller at infidyne.com>
 > >Release:        FreeBSD 6.0-RELEASE-p4 i386
 > >Organization:
 > >Environment:
 > System: FreeBSD starfury.scode.org 6.0-RELEASE-p4 FreeBSD 6.0-RELEASE-p4 =
 #1: Thu Feb 23 16:56:26 CET 2006 scode at starfury.scode.org:/usr/obj/usr/src/=
 sys/STARFURY i386
 >=20
 >=20
 > >Description:
 > 	The geom_mirror_load and geom_label_load sysctl variables should be
 > 	mentioned in their classes' respective manpages. I suspect the same
 > 	is true for the other classes, but I have not personally tried it
 > 	so I am not including it in the patch.
 > >How-To-Repeat:
 > >Fix:
 >=20
 > --- sbin/geom/class/mirror/gmirror.8.orig	Sun Jun 11 12:44:23 2006
 > +++ sbin/geom/class/mirror/gmirror.8	Sun Jun 11 13:05:08 2006
 > @@ -229,6 +229,19 @@
 >  .It Fl v
 >  Be more verbose.
 >  .El
 > +.Sh SYSCTL VARIABLES
 > +The following
 > +.Xr sysctl 8
 > +variables can be used to control the behavior of
 > +the
 > +.Nm MIRROR
 > +GEOM class. The default value is shown next to each variable.
 > +.Bl -tag -width indent
 > +.It Va geom_mirror_load : No 0
 > +When set to 1, instructs the kernel to automatically load the
 > +.Nm MIRROR
 > +GEOM class on boot.
 > +.El
 >  .Sh EXIT STATUS
 >  Exit status is 0 on success, and 1 if the command fails.
 >  .Sh EXAMPLES
 > --- sbin/geom/class/label/glabel.8.orig	Sun Jun 11 13:05:42 2006
 > +++ sbin/geom/class/label/glabel.8	Sun Jun 11 13:06:29 2006
 > @@ -184,6 +184,10 @@
 >  This can be set to a number between 0 and 2 inclusive.
 >  If set to 0 minimal debug information is printed, and if set to 2 the
 >  maximum amount of debug information is printed.
 > +.It Va geom_label_load : No 0
 > +When set to 1, instructs the kernel to automatically load the
 > +.Nm LABEL
 > +GEOM class on boot.
 >  .El
 >  .Sh EXIT STATUS
 >  Exit status is 0 on success, and 1 if the command fails.
 >=20
 >=20
 
 These are not sysctl variables, but loader instructions.  Also IMHO they
 don't really belong in section 8 manpages.  Instead short section 4
 manpages for each geom module should be written (some of the information
 in the section 8 manpages should probably be moved there then).
 
 - Christian
 
 --=20
 Christian Brueffer	chris at unixpages.org	brueffer at FreeBSD.org
 GPG Key:	 http://people.freebsd.org/~brueffer/brueffer.key.asc
 GPG Fingerprint: A5C8 2099 19FF AACA F41B  B29B 6C76 178C A0ED 982D
 
 --WIyZ46R2i8wDzkSu
 Content-Type: application/pgp-signature
 Content-Disposition: inline
 
 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.4.2.2 (FreeBSD)
 
 iD8DBQFEjANebHYXjKDtmC0RAmu4AJ90JlVLvNoFleMuz1NDrJEdZAJwCwCfTyms
 LOq1cwwH5loXKHHCciIZC0U=
 =oRDF
 -----END PGP SIGNATURE-----
 
 --WIyZ46R2i8wDzkSu--