From owner-freebsd-doc  Sun Nov  5  3:50: 7 2000
Delivered-To: freebsd-doc@freebsd.org
Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21])
	by hub.freebsd.org (Postfix) with ESMTP id 9304837B4D7
	for <freebsd-doc@freebsd.org>; Sun,  5 Nov 2000 03:50:01 -0800 (PST)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.9.3/8.9.2) id DAA67428;
	Sun, 5 Nov 2000 03:50:01 -0800 (PST)
	(envelope-from gnats@FreeBSD.org)
Received: from anchor-post-31.mail.demon.net (anchor-post-31.mail.demon.net [194.217.242.89])
	by hub.freebsd.org (Postfix) with ESMTP id DFB2037B479
	for <FreeBSD-gnats-submit@freebsd.org>; Sun,  5 Nov 2000 03:46:21 -0800 (PST)
Received: from plasm.demon.co.uk ([194.222.58.229])
	by anchor-post-31.mail.demon.net with esmtp (Exim 2.12 #1)
	id 13sOFf-0008ME-0V
	for FreeBSD-gnats-submit@freebsd.org; Sun, 5 Nov 2000 11:46:20 +0000
Received: (from matthew@localhost)
	by plasm.demon.co.uk (8.11.1/8.11.1) id eA5BQHG09666;
	Sun, 5 Nov 2000 11:26:17 GMT
	(envelope-from matthew)
Message-Id: <200011051126.eA5BQHG09666@plasm.demon.co.uk>
Date: Sun, 5 Nov 2000 11:26:17 GMT
From: m.seaman@plasm.demon.co.uk
To: FreeBSD-gnats-submit@freebsd.org
X-Send-Pr-Version: 3.2
Subject: docs/22618: [Patch] heap(3) man page malformed
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.org


>Number:         22618
>Category:       docs
>Synopsis:       [Patch] heap(3) man page malformed
>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:   Sun Nov 05 03:50:01 PST 2000
>Closed-Date:
>Last-Modified:
>Originator:     Matthew Seaman
>Release:        FreeBSD 4.2-BETA i386
>Organization:
Disorganised
>Environment:

plasm:~:% uname -a 
FreeBSD plasm.demon.co.uk 4.2-BETA FreeBSD 4.2-BETA #0: Sat Nov  4 15:59:55 GMT 2000     root@plasm.demon.co.uk:/home/obj/usr/src/sys/PLASM  i386

>Description:

	/usr/src/contrib/bind/lib/isc/heap.mdoc has some oddities that
	cause `makewhatis -v /usr/share/man' to suggest:

	Maybe /usr/share/man/man3/heap.3.gz is not a manpage

	The page also lacks a proper header line and has two
	DESCRIPTION sections, but no NAME.
 
>How-To-Repeat:

	makewhatis -v /usr/share/man
	man 3 heap

>Fix:

Comparison between /usr/src/contrib/bid/lib/{heap,tree}.mdoc results
in this patch:

--- heap.mdoc.orig	Sun Nov  5 10:41:16 2000
+++ heap.mdoc	Sun Nov  5 10:47:24 2000
@@ -1,11 +1,11 @@
 .\" $Id: heap.mdoc,v 8.5 1999/01/08 19:25:38 vixie Exp $
 .\"
 .\"Copyright (c) 1997,1999 by Internet Software Consortium.
- *
+.\"
 .\"Permission to use, copy, modify, and distribute this software for any
 .\"purpose with or without fee is hereby granted, provided that the above
 .\"copyright notice and this permission notice appear in all copies.
- *
+.\"
 .\"THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
 .\"ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
 .\"OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
@@ -18,9 +18,8 @@
 .Dd Jan 1, 1997
 .\"Os OPERATING_SYSTEM [version/release]
 .Os BSD 4
-.\" TODO--get correct section # below!!
-.Dt HEAP @SYSCALL_EXT@
-.Sh DESCRIPTION
+.Dt HEAP 3
+.Sh NAME
 .Nm heap_new ,
 .Nm heap_free ,
 .Nm heap_insert ,

>Release-Note:
>Audit-Trail:
>Unformatted:


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message