From redpixel@c164-147.pro.thalamus.se  Sun Feb  3 04:15:44 2002
Return-Path: <redpixel@c164-147.pro.thalamus.se>
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
Cc:
Subject: DECLARE_MODULE(9) man page is broken. 
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         34583
>Category:       docs
>Synopsis:       DECLARE_MODULE(9) man page is broken.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    murray
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Feb 03 04:20:01 PST 2002
>Closed-Date:    Sun Jun 09 21:39:30 PDT 2002
>Last-Modified:  Sun Jun 09 21:39:30 PDT 2002
>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:
Responsible-Changed-From-To: freebsd-doc->murray 
Responsible-Changed-By: murray 
Responsible-Changed-When: Thu Mar 28 01:31:46 PST 2002 
Responsible-Changed-Why:  
I will take a look at this. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=34583 
State-Changed-From-To: open->closed 
State-Changed-By: davidc 
State-Changed-When: Sun Jun 9 21:37:35 PDT 2002 
State-Changed-Why:  
Closed by applying the included patch. 

Rev: 1.6 
Approved by: murray 

http://www.freebsd.org/cgi/query-pr.cgi?pr=34583 
>Unformatted:
