From owner-freebsd-doc@FreeBSD.ORG  Mon Jan  3 19:40:12 2011
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@hub.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 7657E1065672
	for <freebsd-doc@hub.freebsd.org>; Mon,  3 Jan 2011 19:40:12 +0000 (UTC)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (freefall.freebsd.org
	[IPv6:2001:4f8:fff6::28])
	by mx1.freebsd.org (Postfix) with ESMTP id 4B9D28FC15
	for <freebsd-doc@hub.freebsd.org>; Mon,  3 Jan 2011 19:40:12 +0000 (UTC)
Received: from freefall.freebsd.org (localhost [127.0.0.1])
	by freefall.freebsd.org (8.14.4/8.14.4) with ESMTP id p03JeCq2005980
	for <freebsd-doc@freefall.freebsd.org>; Mon, 3 Jan 2011 19:40:12 GMT
	(envelope-from gnats@freefall.freebsd.org)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.14.4/8.14.4/Submit) id p03JeCF7005978;
	Mon, 3 Jan 2011 19:40:12 GMT (envelope-from gnats)
Date: Mon, 3 Jan 2011 19:40:12 GMT
Message-Id: <201101031940.p03JeCF7005978@freefall.freebsd.org>
To: freebsd-doc@FreeBSD.org
From: John Baldwin <jhb@freebsd.org>
Cc: 
Subject: Re: docs/153654: [patch] incorrect include in sysctl.9
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
Reply-To: John Baldwin <jhb@freebsd.org>
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 03 Jan 2011 19:40:12 -0000

The following reply was made to PR docs/153654; it has been noted by GNATS.

From: John Baldwin <jhb@freebsd.org>
To: freebsd-doc@freebsd.org
Cc: Joris Dedieu <joris.dedieu@gmail.com>,
 freebsd-gnats-submit@freebsd.org
Subject: Re: docs/153654: [patch] incorrect include in sysctl.9
Date: Mon, 3 Jan 2011 14:06:18 -0500

 On Monday, January 03, 2011 12:58:53 pm Joris Dedieu wrote:
 > 
 > >Number:         153654
 > >Category:       docs
 > >Synopsis:       [patch] incorrect include in sysctl.9
 > >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:   Mon Jan 03 18:00:24 UTC 2011
 > >Closed-Date:
 > >Last-Modified:
 > >Originator:     Joris Dedieu
 > >Release:        8.1-RELEASE-p2
 > >Organization:
 > >Environment:
 > FreeBSD ladybug2.rmdir.fr 8.1-RELEASE-p2 FreeBSD 8.1-RELEASE-p2 #0: Mon Dec 27 15:39:23 CET 2010     
 joris@ladybug2.rmdir.fr:/usr/obj/usr/src/sys/GENERIC  amd64
 > 
 > >Description:
 > Has DATA_SET is defined in sys/kernel.h most SYSTL_* macros don't work if you don't include it.
 > >How-To-Repeat:
 > 
 > >Fix:
 > --- share/man/man9/sysctl.9.orig        2011-01-03 18:43:53.000000000 +0100
 > +++ share/man/man9/sysctl.9     2011-01-03 18:44:17.000000000 +0100
 > @@ -44,7 +44,7 @@
 >  .Nm SYSCTL_QUAD
 >  .Nd Static sysctl declaration functions
 >  .Sh SYNOPSIS
 > -.In sys/types.h
 > +.In sys/kernel.h
 >  .In sys/sysctl.h
 >  .Fn SYSCTL_DECL name
 >  .Fn SYSCTL_INT parent nbr name access ptr val descr
 
 <sys/kernel.h> does not include <sys/types.h>.  Plus, all of <sys/kernel.h>
 is not needed.  <sys/linker_set.h> is what defines DATA_SET().  This is
 probably the "right" set of includes:
 
 #include <sys/types.h>
 #include <sys/linker_set.h>
 #include <sys/sysctl.h>
 
 OTOH, <sysctl.h> should perhaps have a nested include of <sys/linker_set.h>
 in the #ifdef _KERNEL case in which case the manpage would not need changing.
 
 -- 
 John Baldwin