summaryrefslogtreecommitdiffstats
path: root/share/man/man9/DECLARE_GEOM_CLASS.9
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/man9/DECLARE_GEOM_CLASS.9')
-rw-r--r--share/man/man9/DECLARE_GEOM_CLASS.917
1 files changed, 9 insertions, 8 deletions
diff --git a/share/man/man9/DECLARE_GEOM_CLASS.9 b/share/man/man9/DECLARE_GEOM_CLASS.9
index 4972caa..7c21587 100644
--- a/share/man/man9/DECLARE_GEOM_CLASS.9
+++ b/share/man/man9/DECLARE_GEOM_CLASS.9
@@ -38,7 +38,9 @@ The
.Fn DECLARE_GEOM_CLASS
macro registers a GEOM class in GEOM.
A GEOM class itself implements one particular kind of transformation.
-Typical examples are: MBR disk partition, BSD disklabel and RAID5 classes.
+Typical examples are: MBR disk partition,
+.Bx
+disklabel and RAID5 classes.
.Fn DECLARE_GEOM_CLASS
can be used both for compiled in and loaded as
.Xr kld 4
@@ -48,11 +50,11 @@ The arguments to
.Fn DECLARE_GEOM_CLASS
are:
.Bl -inset -offset indent
-.It Em class
+.It Fa class
is the
.Vt g_class
structure which describes a GEOM class.
-.It Em mod_name
+.It Fa mod_name
is a kernel module name (not a class name!).
.El
.Pp
@@ -60,15 +62,16 @@ Structure
.Vt g_class
contains data describing the class.
They are:
-.Bl -inset -offset indent
+.Bl -tag -offset indent -width indent
.It Vt "const char *" Va name
Class name.
.It Vt "g_taste_t *" Va taste
Pointer to function used for taste event handling.
If it is
-.No non- Ns Dv NULL
+.Pf non- Dv NULL
it is called in three situations:
-.Bl -dash -offset indent -compact
+.Pp
+.Bl -dash -compact
.It
On class activation, all existing providers are offered for tasting.
.It
@@ -97,12 +100,10 @@ If this field is not set, the class can not be unloaded.
Only field
.Fa name
is required, the rest is optional.
-.Pp
.Sh RESTRICTIONS/CONDITIONS
In the
.Vt g_class
initialization one must use C99 initialization (just like in the example below).
-.Pp
.Sh EXAMPLES
Example class declaration.
.Bd -literal -offset indent
OpenPOWER on IntegriCloud