[src/trunk]: src/share/man/man9 Explicitly note that the required argument to...

[pgoyette <pgoyette%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/5a71836fe9c0
branches:  trunk
changeset: 358202:5a71836fe9c0
user:      pgoyette <pgoyette%NetBSD.org@localhost>
date:      Sat Dec 16 21:13:07 2017 +0000

description:
Explicitly note that the required argument to the MODULE() macro is
a quoted string, or NULL.

diffstat:

 share/man/man9/module.9 |  15 +++++++++++----
 1 files changed, 11 insertions(+), 4 deletions(-)

diffs (43 lines):

diff -r ea6721a7f2ae -r 5a71836fe9c0 share/man/man9/module.9
--- a/share/man/man9/module.9   Sat Dec 16 20:44:54 2017 +0000
+++ b/share/man/man9/module.9   Sat Dec 16 21:13:07 2017 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: module.9,v 1.39 2017/12/16 12:40:30 pgoyette Exp $
+.\"    $NetBSD: module.9,v 1.40 2017/12/16 21:13:07 pgoyette Exp $
 .\"
 .\" Copyright (c) 2010 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -133,13 +133,16 @@
 .Pp
 The
 .Fa required
-argument contains a comma-separated list of module names that are required
-by this module.
+argument is a quoted string containing a comma-separated list of module
+names that are required by this module.
 The list must not contain any white-space.
 When a module is loaded, all of its required modules are auto-loaded and
 initialized before the module itself is loaded.
 Loading of required modules is a recursive operation.
 .Pp
+If there are no required modules, this argument should be specified as
+.Dv NULL .
+.Pp
 In addition to the explicit arguments, the
 .Fn MODULE
 macro creates a reference to the module's
@@ -148,9 +151,13 @@
 This function is defined as:
 .Bl -tag -width modcmd -offset indent
 .It Ft int
-.Fn modcmd "modcmd_t cmd" "void *data"
+.Fn xxx_modcmd "modcmd_t cmd" "void *data"
 .El
 .Pp
+(where xxx is the name of the module, from the
+.Dv MODULE
+macro).
+.Pp
 The
 .Fa cmd
 argument requests one of the following operations: