From owner-freebsd-doc  Sun Feb  3  4:20:13 2002
Delivered-To: freebsd-doc@freebsd.org
Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21])
	by hub.freebsd.org (Postfix) with ESMTP id 838C837B404
	for <freebsd-doc@freebsd.org>; Sun,  3 Feb 2002 04:20:01 -0800 (PST)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.11.6/8.11.6) id g13CK1i04678;
	Sun, 3 Feb 2002 04:20:01 -0800 (PST)
	(envelope-from gnats)
Received: from c164-147.pro.thalamus.se (c164-147.pro.thalamus.se [212.31.164.147])
	by hub.freebsd.org (Postfix) with ESMTP id 19AAA37B416
	for <FreeBSD-gnats-submit@freebsd.org>; Sun,  3 Feb 2002 04:15:22 -0800 (PST)
Received: (from redpixel@localhost)
	by c164-147.pro.thalamus.se (8.11.6/8.11.6) id g13CFK201007;
	Sun, 3 Feb 2002 13:15:20 +0100 (CET)
	(envelope-from redpixel)
Message-Id: <200202031215.g13CFK201007@c164-147.pro.thalamus.se>
Date: Sun, 3 Feb 2002 13:15:20 +0100 (CET)
From: Martin Faxer <redpixel@c164-147.pro.thalamus.se>
Reply-To: Martin Faxer <gmh003532@brfmasthugget.se>
To: FreeBSD-gnats-submit@freebsd.org
X-Send-Pr-Version: 3.113
Subject: docs/34583: DECLARE_MODULE(9) man page is broken. 
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-doc.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-doc>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-doc>
X-Loop: FreeBSD.org


>Number:         34583
>Category:       docs
>Synopsis:       DECLARE_MODULE(9) man page is broken.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Feb 03 04:20:01 PST 2002
>Closed-Date:
>Last-Modified:
>Originator:     Martin Faxer
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
None 
>Environment:
System: FreeBSD lockdown.nodomain 5.0-CURRENT FreeBSD 5.0-CURRENT #8: Thu Jan 24 16:58:51 CET 2002 redpixel@lockdown.nodomain:/usr/obj/usr/src/sys/LOCKDOWN i386


	
>Description:
	
	The DECLARE_MODULE(9) man page has a few inaccuracies.
	It states that a pointer to a moduledata_t is to be passed, when
	in fact you're supposed to pass the structure itself, which will
	be used as &structure by the SYSINIT() macro.
	The other inaccuracy is that it states that the valid values
	for ``sub'' are kept in the sysstem_sub_id enumeration.
	First off, it's misspelled; it should be system_sub_id, secondly,
	the name has changed and it's now sysinit_sub_id.

>How-To-Repeat:
	
	Read the DECLARE_MODULE(9) man page, rev 1.5.
>Fix:

	
	Apply the following fix against rev 1.5 of
	/usr/src/share/man/man9/DECLARE_MODULE.9

--- DECLARE_MODULE.diff begins here ---
--- DECLARE_MODULE.9.orig	Sun Feb  3 12:47:46 2002
+++ DECLARE_MODULE.9	Sun Feb  3 12:49:10 2002
@@ -64,7 +64,7 @@
 call to identify the module.
 .Pp
 .Fa data
-is a pointer to the
+is a
 .Vt moduledata_t
 structure, which contains two main items, the official name of the
 module name, which will be used in the
@@ -77,7 +77,7 @@
 .Fn SYSINIT
 macro.
 Valid values for this are contained in the
-.Vt sysstem_sub_id
+.Vt sysinit_sub_id
 enumeration
 (see
 .Pa kernel.h )
--- DECLARE_MODULE.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted:

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message