. Use a .Bl list for describing macro arguments.

. Various wordign fixes.
. Bump document date.

MFC after:	3 days
This commit is contained in:
keramida 2005-01-06 17:16:01 +00:00
parent 1d4742efe6
commit 0656c5b050

View File

@ -28,7 +28,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd March 3, 2001
.Dd January 6, 2005
.Dt DECLARE_MODULE 9
.Os
.Sh NAME
@ -52,28 +52,27 @@ is usually used within other macros, such as
.Xr DEV_MODULE 9
and
.Xr SYSCALL_MODULE 9 .
However, it can be called directly of course, for example in
Of course, it can also be called directly, for example in
order to implement dynamic sysctls.
.Pp
The arguments to
.Fn DECLARE_MODULE :
.Pp
.Fa name
is the name of the module, which will be used in the
.Fn DECLARE_MODULE
expects are:
.Bl -tag -width indent
.It Fa name
The module name, which will be used in the
.Fn SYSINIT
call to identify the module.
.Pp
.Fa data
is a
.It Fa data
A
.Vt moduledata_t
structure, which contains two main items, the official name of the
module name, which will be used in the
.Vt module_t
structure and a pointer to the event handler function of type
.Vt modeventhand_t .
.Pp
.Fa sub
is an argument directed to the
.It Fa sub
An argument directed to the
.Fn SYSINIT
macro.
Valid values for this are contained in the
@ -90,16 +89,15 @@ here for example, since these modules contain a driver for a device.
For kernel modules that are loaded at runtime, a value of
.Dv SI_SUB_EXEC
is common.
.Pp
The
.Fa order
value is another argument for
.It Fa order
An argument for
.Fn SYSINIT .
It represents the KLDs order of initialization within the subsystem.
Valid values are defined in the
.Vt sysinit_elem_order
enumeration
.Pq In sys/kernel.h .
.El
.Sh SEE ALSO
.Xr DEV_MODULE 9 ,
.Xr DRIVER_MODULE 9 ,