From owner-freebsd-doc@FreeBSD.ORG Sun Jun 11 13:20:23 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 A67BC16A484 for ; Sun, 11 Jun 2006 13:20:23 +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 9495043D55 for ; Sun, 11 Jun 2006 13:20:21 +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 k5BDKLh7011705 for ; Sun, 11 Jun 2006 13:20:21 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.13.4/8.13.4/Submit) id k5BDKLO3011704; Sun, 11 Jun 2006 13:20:21 GMT (envelope-from gnats) Date: Sun, 11 Jun 2006 13:20:21 GMT Message-Id: <200606111320.k5BDKLO3011704@freefall.freebsd.org> To: freebsd-doc@FreeBSD.org From: Peter Schuller 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: Peter Schuller List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 11 Jun 2006 13:20:23 -0000 The following reply was made to PR docs/98801; it has been noted by GNATS. From: Peter Schuller To: Christian Brueffer Cc: FreeBSD-gnats-submit@freebsd.org Subject: Re: docs/98801: gmirror(8) and glabel(8) manpages should mention geom_{mirror, label}_load Date: Sun, 11 Jun 2006 15:11:14 +0200 > These are not sysctl variables, but loader instructions. I was not sure about the nomenclature. I ended up doing what I did based on gstripe(8), which lists loader variables under sysctl variables, but with a note saying they cannot be changed after boot (though I realize I forgot to do the latter). > 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). On the other hand it is very relevant to anyone reading gmirror(8) or glabel(8). At the very least it seems adding it to (8) is better than leaving it as-is, not documented at all. I can propose new section 4 manpages, but I am not sure how much from their corresponding section 8 manpages really belong there. Would you feel a separate manpage is warranted even if it essentially only contains the relevant loader instructions? While there is some information in gmirror(8)/gmirror(9) that refer to the workings of the geom class itself, rather than the tool, I don't know how much sense it makes to try to strip those pages of that information given that it is so directly relevant to operation of the tool. Perhaps the introductory general information on meta-data layout and general operations. I presume the section for manpages would preferably be named geom_XXX (in keeping with geom(4)). -- / Peter Schuller, InfiDyne Technologies HB PGP userID: 0xE9758B7D or 'Peter Schuller ' Key retrieval: Send an E-Mail to getpgpkey@scode.org E-Mail: peter.schuller@infidyne.com Web: http://www.scode.org