From owner-freebsd-doc@FreeBSD.ORG Wed Jun 14 14:50:19 2006 Return-Path: X-Original-To: freebsd-doc@hub.freebsd.org Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 0CCAB16A47D for ; Wed, 14 Jun 2006 14:50:19 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id 42AE743D5A for ; Wed, 14 Jun 2006 14:50:17 +0000 (GMT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.13.4/8.13.4) with ESMTP id k5EEoG9G020433 for ; Wed, 14 Jun 2006 14:50:16 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.13.4/8.13.4/Submit) id k5EEoGsq020432; Wed, 14 Jun 2006 14:50:16 GMT (envelope-from gnats) Date: Wed, 14 Jun 2006 14:50:16 GMT Message-Id: <200606141450.k5EEoGsq020432@freefall.freebsd.org> To: freebsd-doc@FreeBSD.org From: Christian Brueffer Cc: Subject: Re: docs/98801: gmirror(8) and glabel(8) manpages should mention geom_{mirror, label}_load X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: Christian Brueffer List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 14 Jun 2006 14:50:19 -0000 The following reply was made to PR docs/98801; it has been noted by GNATS. From: Christian Brueffer To: Peter Schuller , FreeBSD-gnats-submit@freebsd.org Cc: Subject: Re: docs/98801: gmirror(8) and glabel(8) manpages should mention geom_{mirror, label}_load Date: Wed, 14 Jun 2006 16:43:12 +0200 --TakKZr9L6Hm6aLOc Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Sun, Jun 11, 2006 at 03:11:14PM +0200, Peter Schuller wrote: > > These are not sysctl variables, but loader instructions.=20 >=20 > I was not sure about the nomenclature. I ended up doing what I did based = on=20 > gstripe(8), which lists loader variables under sysctl variables, but with= a=20 > note saying they cannot be changed after boot (though I realize I forgot = to=20 > do the latter). >=20 > > Also IMHO they=20 > > 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). >=20 > On the other hand it is very relevant to anyone reading gmirror(8) or=20 > glabel(8). At the very least it seems adding it to (8) is better than=20 > leaving it as-is, not documented at all. >=20 > I can propose new section 4 manpages, but I am not sure how much from the= ir=20 > corresponding section 8 manpages really belong there. Would you feel a=20 > separate manpage is warranted even if it essentially only contains the=20 > relevant loader instructions? >=20 > While there is some information in gmirror(8)/gmirror(9) that refer to th= e=20 > workings of the geom class itself, rather than the tool, I don't know how= =20 > much sense it makes to try to strip those pages of that information given= =20 > that it is so directly relevant to operation of the tool. Perhaps the=20 > introductory general information on meta-data layout and general operatio= ns. >=20 IMHO all information about the implementation of the class should go into section 4 manpage as well. "Would it make sense to just put the module information in there if nothing else is available?" IMHO yes, together with one or two lines about what the module does. One of our aims is actually to have a manpage for every kernel driver/option/whatever (or an MLINK to a relevant manpage). > I presume the section for manpages would preferably be named geom_XXX (in= =20 > keeping with geom(4)). >=20 Yes, probably with an MLINK to e.g. gmirror(4). - Christian --=20 Christian Brueffer chris@unixpages.org brueffer@FreeBSD.org GPG Key: http://people.freebsd.org/~brueffer/brueffer.key.asc GPG Fingerprint: A5C8 2099 19FF AACA F41B B29B 6C76 178C A0ED 982D --TakKZr9L6Hm6aLOc Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.2.2 (FreeBSD) iD8DBQFEkCCAbHYXjKDtmC0RAiTeAKCYq1kJXUn7BJB896xzk0uCqQOdvgCgl3jI s5hba23A4GZ74EFyinbubWY= =cSA6 -----END PGP SIGNATURE----- --TakKZr9L6Hm6aLOc--