Date: Sat, 9 Mar 2013 10:11:23 +0100 From: Joel Dahl <joel@freebsd.org> To: doc@freebsd.org Subject: Documenting various GEOM_* kernel options Message-ID: <20130309091122.GH17537@devbox.vnode.local>
next in thread | raw e-mail | index | archive | help
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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20130309091122.GH17537>