From owner-freebsd-doc@FreeBSD.ORG Wed Sep 3 17:50:19 2003 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 6888F16A4C1 for ; Wed, 3 Sep 2003 17:50:19 -0700 (PDT) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id 3489243FF3 for ; Wed, 3 Sep 2003 17:50:18 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.12.9/8.12.9) with ESMTP id h840oIUp067798 for ; Wed, 3 Sep 2003 17:50:18 -0700 (PDT) (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.12.9/8.12.9/Submit) id h840oIln067797; Wed, 3 Sep 2003 17:50:18 -0700 (PDT) Resent-Date: Wed, 3 Sep 2003 17:50:18 -0700 (PDT) Resent-Message-Id: <200309040050.h840oIln067797@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Simon Barner Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id C8A6616A4C3 for ; Wed, 3 Sep 2003 17:44:17 -0700 (PDT) Received: from mailout.informatik.tu-muenchen.de (mailout.informatik.tu-muenchen.de [131.159.0.5]) by mx1.FreeBSD.org (Postfix) with ESMTP id EE93343F85 for ; Wed, 3 Sep 2003 17:44:16 -0700 (PDT) (envelope-from barner@in.tum.de) Received: by zi025.glhnet.mhn.de (Postfix, from userid 1000) id 7266238A23; Thu, 4 Sep 2003 02:44:15 +0200 (CEST) Message-Id: <20030904004415.7266238A23@zi025.glhnet.mhn.de> Date: Thu, 4 Sep 2003 02:44:15 +0200 (CEST) From: Simon Barner To: FreeBSD-gnats-submit@FreeBSD.org X-Send-Pr-Version: 3.113 Subject: docs/56388: Add/change #include lines for libisc man pages X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list Reply-To: Simon Barner List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 04 Sep 2003 00:50:19 -0000 >Number: 56388 >Category: docs >Synopsis: Add/change #include lines for libisc man pages >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: Wed Sep 03 17:50:17 PDT 2003 >Closed-Date: >Last-Modified: >Originator: Simon Barner >Release: FreeBSD 4.8-STABLE i386 >Organization: >Environment: System: FreeBSD zi025.glhnet.mhn.de 4.8-STABLE FreeBSD 4.8-STABLE #0: Thu Aug 7 04:04:01 CEST 2003 toor@zi025.glhnet.mhn.de:/usr/src/sys/compile/KISTE i386 >Description: The man pages for some of the functions of libisc (which comes with BIND) do not contain a valid #include line in the SYNOPSIS section. >How-To-Repeat: See for example `man 3 tree_init'. >Fix: This patch adds these #include lines. I am not too sure about its last hunk, but I think those lines can be removed from the Makefile, since they did not have the desired effect (see for example `man 3 heap_new', which still contains #include "heap.h" instead of #include --- contrib/bind/lib/isc/bitncmp.mdoc.orig Thu Sep 4 02:16:17 2003 +++ contrib/bind/lib/isc/bitncmp.mdoc Thu Sep 4 02:19:00 2003 @@ -22,6 +22,7 @@ .Nm bitncmp .Nd compare bit masks .Sh SYNOPSIS +.Fd #include .Ft int .Fn bitncmp "const void *l" "const void *r" "int n" .Sh DESCRIPTION --- contrib/bind/lib/isc/heap.mdoc.orig Thu Sep 4 02:16:17 2003 +++ contrib/bind/lib/isc/heap.mdoc Thu Sep 4 02:20:38 2003 @@ -30,7 +30,7 @@ .Nm heap_for_each .Nd heap implementation of priority queues .Sh SYNOPSIS -.Fd #include \&"heap.h\&" +.Fd #include .Ft heap_context .Fn heap_new "heap_higher_priority_func higher_priority" \ "heap_index_func index" "int array_size_increment" --- contrib/bind/lib/isc/memcluster.mdoc.orig Thu Sep 4 02:16:17 2003 +++ contrib/bind/lib/isc/memcluster.mdoc Thu Sep 4 02:21:42 2003 @@ -28,7 +28,7 @@ .Nm memstats .Nd memory allocation/deallocation system .Sh SYNOPSIS -.Fd #include \& +.Fd #include .Ft void * .Fn memget "size_t size" .Ft void --- contrib/bind/lib/isc/tree.mdoc.orig Thu Sep 4 02:16:17 2003 +++ contrib/bind/lib/isc/tree.mdoc Thu Sep 4 02:22:20 2003 @@ -27,6 +27,7 @@ .Nm tree_trav .Nd balanced binary tree routines .Sh SYNOPSIS +.Fd #include .Ft void .Fn tree_init "void **tree" .Ft void * --- lib/libisc/Makefile.orig Thu Sep 4 02:27:49 2003 +++ lib/libisc/Makefile Thu Sep 4 02:28:18 2003 @@ -128,14 +128,3 @@ tree.3 tree_trav.3 .include - -# This has to come after the .include . Not sure why. - -.SUFFIXES: .mdoc .3 -.mdoc.3: - sed -e 's/@INDOT@//g' \ - -e 's/@SYSCALL_EXT@/2/g' \ - -e 's/@SYS_OPS_EXT@/8/g' \ - -e 's/^.Fd #include .*heap.h.*/.Fd #include /' \ - < ${.ALLSRC} > ${.TARGET} - >Release-Note: >Audit-Trail: >Unformatted: