From owner-freebsd-doc@FreeBSD.ORG Sat Mar 9 09:11:35 2013 Return-Path: Delivered-To: doc@freebsd.org Received: from mx1.freebsd.org (mx1.FreeBSD.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id 4F1A34A4 for ; Sat, 9 Mar 2013 09:11:35 +0000 (UTC) (envelope-from joel@freebsd.org) Received: from mail.vnode.se (mail.vnode.se [212.247.52.13]) by mx1.freebsd.org (Postfix) with ESMTP id EA6646BF for ; Sat, 9 Mar 2013 09:11:34 +0000 (UTC) Received: from mail.vnode.se (localhost [127.0.0.1]) by mail.vnode.se (Postfix) with ESMTP id 7233EE3F07A for ; Sat, 9 Mar 2013 10:11:26 +0100 (CET) X-Virus-Scanned: amavisd-new at vnode.se Received: from mail.vnode.se ([127.0.0.1]) by mail.vnode.se (mail.vnode.se [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id cp0XyP0ZT2oo for ; Sat, 9 Mar 2013 10:11:24 +0100 (CET) Received: from devbox.vnode.local (unknown [83.223.1.131]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by mail.vnode.se (Postfix) with ESMTPSA id 5D005E3F079 for ; Sat, 9 Mar 2013 10:11:24 +0100 (CET) Date: Sat, 9 Mar 2013 10:11:23 +0100 From: Joel Dahl To: doc@freebsd.org Subject: Documenting various GEOM_* kernel options Message-ID: <20130309091122.GH17537@devbox.vnode.local> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.5.21 (2010-09-15) X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 09 Mar 2013 09:11:35 -0000 Hi, I recently noticed we haven't documented all of the various GEOM_* kernel options in any manual pages. I don't know if this is intentional or not. A quick grep reveals the following ("-" means not documented anywhere): GEOM_AES - GEOM_BDE Documented in gbde(4) manpage GEOM_BSD - GEOM_CACHE - GEOM_CONCAT - GEOM_ELI Documented in geli(8) manpage GEOM_FOX Documented in geom_fox(4) manpage GEOM_GATE Mentioned in hastd(8) GEOM_JOURNAL - GEOM_LABEL - GEOM_LINUX_LVM Documented in geom_linux_lvm(4) manpage GEOM_MBR - GEOM_MIRROR - GEOM_MULTIPATH - GEOM_NOP - GEOM_PART_APM Documented in gpart(8) manpage GEOM_PART_BSD Documented in gpart(8) manpage GEOM_PART_EBR Documented in gpart(8) manpage GEOM_PART_EBR_COMPAT Documented in gpart(8) manpage GEOM_PART_GPT Documented in gpart(8) manpage GEOM_PART_LDM Documented in gpart(8) manpage GEOM_PART_MBR Documented in gpart(8) manpage GEOM_PART_PC98 Documented in gpart(8) manpage GEOM_PART_VTOC8 Documented in gpart(8) manpage GEOM_PC98 - GEOM_RAID - GEOM_RAID3 - GEOM_SHSEC - GEOM_STRIPE - GEOM_SUNLABEL - GEOM_UZIP Documented in geom_uzip(4) manpage GEOM_VIRSTOR - GEOM_VOL - GEOM_ZERO - Both the gpart(8) and geli(8) manpages have kernel options in the SYNOPSIS, which probably isn't correct for section 8 manpages. Some options are already documented in section 4 manpages (GEOM_BDE, GEOM_FOX, GEOM_LINUX_LVM and GEOM_UZIP) but what do we do with the rest? What about using the SYNOPSIS in the geom(4) manpage? Opinions? -- Joel