From brandt@fokus.gmd.de  Fri Feb  2 05:29:29 2001
Return-Path: <brandt@fokus.gmd.de>
Received: from mailhub.fokus.gmd.de (mailhub.fokus.gmd.de [193.174.154.14])
	by hub.freebsd.org (Postfix) with ESMTP id CFE5F37B401
	for <FreeBSD-gnats-submit@freebsd.org>; Fri,  2 Feb 2001 05:29:28 -0800 (PST)
Received: from fokus.gmd.de (beagle [193.175.132.100])
	by mailhub.fokus.gmd.de (8.8.8/8.8.8) with ESMTP id OAA09555
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 2 Feb 2001 14:29:26 +0100 (MET)
Received: (from hbb@localhost)
	by fokus.gmd.de (8.11.2/8.11.0) id f12DTQt02660;
	Fri, 2 Feb 2001 14:29:26 +0100 (CET)
	(envelope-from hbb)
Message-Id: <200102021329.f12DTQt02660@fokus.gmd.de>
Date: Fri, 2 Feb 2001 14:29:26 +0100 (CET)
From: Hartmut Brandt <brandt@fokus.gmd.de>
Reply-To: brandt@fokus.gmd.de
To: FreeBSD-gnats-submit@freebsd.org
Subject: malloc(9) missing #includes in man-page
X-Send-Pr-Version: 3.113

>Number:         24797
>Category:       docs
>Synopsis:       when using MALLOC_DEFINE sys/param.h and sys/kernel.h are needed
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    harti
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Feb 02 05:30:00 PST 2001
>Closed-Date:    Wed Apr 09 02:15:33 PDT 2003
>Last-Modified:  Wed Apr 09 02:15:33 PDT 2003
>Originator:     Harti Brandt
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
GMD Fokus, Berlin
>Environment:
System: FreeBSD beagle.fokus.gmd.de 5.0-CURRENT FreeBSD 5.0-CURRENT #2: Fri Feb 2 10:58:07 CET 2001 hbb@beagle.fokus.gmd.de:/opt/obj/usr/src/sys/BEAGLE i386
>Description:

It should be documented in malloc(9) that sys/param.h is needed to get
NULL defined and sys/kernel.h to get SYSINIT defined when one uses
MALLOC_DEFINE().

>How-To-Repeat:

Try to compile this file:

# include <sys/types.h>
# include <sys/malloc.h>

MALLOC_DEFINE(M_FOOBUF, "foobuffers", "Buffers to foo data into the ether");

and see the compile errors.

>Fix:

Add something like

.Fd #include <sys/param.h>
.Fd #inclued <sys/kernel.h>

just above the line

MALLOC_DEFINE(M_FOOBUF, "foobuffers", "Buffers to foo data into the ether");

in the man page.

>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->phk 
Responsible-Changed-By: nik 
Responsible-Changed-When: Fri Feb 9 11:03:53 PST 2001 
Responsible-Changed-Why:  
Poul, is this a doc bug, or an implementation bug? 

http://www.freebsd.org/cgi/query-pr.cgi?pr=24797 
State-Changed-From-To: open->closed 
State-Changed-By: harti 
State-Changed-When: Wed Apr 9 02:14:36 PDT 2003 
State-Changed-Why:  
Man page changed to document the need of the two additional 
includes for MALLOC_DEFINE. 


Responsible-Changed-From-To: phk->harti 
Responsible-Changed-By: harti 
Responsible-Changed-When: Wed Apr 9 02:14:36 PDT 2003 
Responsible-Changed-Why:  
Man page changed to document the need of the two additional 
includes for MALLOC_DEFINE. 

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