From owner-freebsd-doc@FreeBSD.ORG  Mon Jan  3 19:35:46 2011
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 41C31106566C;
	Mon,  3 Jan 2011 19:35:46 +0000 (UTC) (envelope-from jhb@freebsd.org)
Received: from cyrus.watson.org (cyrus.watson.org [65.122.17.42])
	by mx1.freebsd.org (Postfix) with ESMTP id 122288FC12;
	Mon,  3 Jan 2011 19:35:46 +0000 (UTC)
Received: from bigwig.baldwin.cx (66.111.2.69.static.nyinternet.net
	[66.111.2.69])
	by cyrus.watson.org (Postfix) with ESMTPSA id 9F21E46B2A;
	Mon,  3 Jan 2011 14:35:45 -0500 (EST)
Received: from jhbbsd.localnet (smtp.hudson-trading.com [209.249.190.9])
	by bigwig.baldwin.cx (Postfix) with ESMTPSA id C020F8A01D;
	Mon,  3 Jan 2011 14:35:44 -0500 (EST)
From: John Baldwin <jhb@freebsd.org>
To: freebsd-doc@freebsd.org
Date: Mon, 3 Jan 2011 14:06:18 -0500
User-Agent: KMail/1.13.5 (FreeBSD/7.3-CBSD-20101102; KDE/4.4.5; amd64; ; )
References: <201101031758.p03Hwr7k054742@red.freebsd.org>
In-Reply-To: <201101031758.p03Hwr7k054742@red.freebsd.org>
MIME-Version: 1.0
Content-Type: Text/Plain;
  charset="iso-8859-15"
Content-Transfer-Encoding: 7bit
Message-Id: <201101031406.18219.jhb@freebsd.org>
X-Greylist: Sender succeeded SMTP AUTH, not delayed by milter-greylist-4.2.6
	(bigwig.baldwin.cx); Mon, 03 Jan 2011 14:35:44 -0500 (EST)
X-Virus-Scanned: clamav-milter 0.96.3 at bigwig.baldwin.cx
X-Virus-Status: Clean
X-Spam-Status: No, score=-1.9 required=4.2 tests=BAYES_00 autolearn=ham
	version=3.3.1
X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on bigwig.baldwin.cx
Cc: Joris Dedieu <joris.dedieu@gmail.com>, freebsd-gnats-submit@freebsd.org
Subject: Re: docs/153654: [patch] incorrect include in sysctl.9
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
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:35:46 -0000

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