Date: Thu, 4 Sep 2003 02:44:15 +0200 (CEST) From: Simon Barner <barner@in.tum.de> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/56388: Add/change #include lines for libisc man pages Message-ID: <20030904004415.7266238A23@zi025.glhnet.mhn.de> Resent-Message-ID: <200309040050.h840oIln067797@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>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 <isc/heap.h>
--- 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 <isc/misc.h>
.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 <isc/heap.h>
.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 \&<isc/memcluster.h\&>
+.Fd #include <isc/memcluster.h>
.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 <isc/tree.h>
.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 <bsd.lib.mk>
-
-# This has to come after the .include <bsd.lib.mk>. 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 <isc\/heap.h>/' \
- < ${.ALLSRC} > ${.TARGET}
-
>Release-Note:
>Audit-Trail:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030904004415.7266238A23>