NetBSD Problem Report #46814

From lloyd@thallid.must-have-coffee.gen.nz  Sun Aug 19 00:14:38 2012
Return-Path: <lloyd@thallid.must-have-coffee.gen.nz>
Received: from mail.netbsd.org (mail.netbsd.org [149.20.53.66])
	by www.NetBSD.org (Postfix) with ESMTP id CB2D163B882
	for <gnats-bugs@gnats.NetBSD.org>; Sun, 19 Aug 2012 00:14:37 +0000 (UTC)
Message-Id: <20120819001425.0CE96349EBA@thallid.must-have-coffee.gen.nz>
Date: Sun, 19 Aug 2012 12:14:25 +1200 (NZST)
From: lloyd@thallid.must-have-coffee.gen.nz
Reply-To: lloyd@must-have-coffee.gen.nz
To: gnats-bugs@gnats.NetBSD.org
Subject: Information missing from rbtree(3) manual page
X-Send-Pr-Version: 3.95

>Number:         46814
>Category:       lib
>Synopsis:       Information missing from rbtree(3) manual page.
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    lib-bug-people
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sun Aug 19 00:15:00 +0000 2012
>Closed-Date:    Sun Aug 19 19:32:39 +0000 2012
>Last-Modified:  Mon Sep 03 18:45:01 +0000 2012
>Originator:     Lloyd Parkes
>Release:        NetBSD 6.0_BETA2
>Organization:
Must Have Coffee
>Environment:
System: NetBSD thallid.must-have-coffee.gen.nz 6.0_BETA2 NetBSD 6.0_BETA2 (XEN3PAE_DOMU) #0: Mon Jun 18 04:48:20 NZST 2012 lloyd@bob:/vol/scratch/build6/obj.i386/sys/arch/i386/compile/XEN3PAE_DOMU i386
Architecture: i386
Machine: i386
>Description:

None of the function types listed in the rbtree manual page have parameter names, which makes the function types difficult (and in some cases impossible) to read. In particular, rbto_compare_nodes_fn and rbto_compare_key_fn take three void pointers as parameters. Two of the void pointers for rbto_compare_key_fn are indistinguishable, but they are required to point to different types of objects. 

>How-To-Repeat:

Type "man rbtree". Then type "man memcmp" for a more informative manual page.

>Fix:

Just add some parameter names.

>Release-Note:

>Audit-Trail:

State-Changed-From-To: open->feedback
State-Changed-By: wiz@NetBSD.org
State-Changed-When: Sun, 19 Aug 2012 19:31:56 +0000
State-Changed-Why:
I've just improved the man page on current, please let me know if the
information there is now sufficient for you, or, if not, what you find
missing. Thanks.


State-Changed-From-To: feedback->closed
State-Changed-By: wiz@NetBSD.org
State-Changed-When: Sun, 19 Aug 2012 19:32:39 +0000
State-Changed-Why:
Mail bounced, no point in waiting for feedback.


From: "Thomas Klausner" <wiz@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/46814 CVS commit: src/share/man/man3
Date: Sun, 19 Aug 2012 19:31:14 +0000

 Module Name:	src
 Committed By:	wiz
 Date:		Sun Aug 19 19:31:14 UTC 2012

 Modified Files:
 	src/share/man/man3: rbtree.3

 Log Message:
 Add more function argument names to the man page, trying to address
 PR 46814 by Lloyd Parkes. Bump date.


 To generate a diff of this commit:
 cvs rdiff -u -r1.6 -r1.7 src/share/man/man3/rbtree.3

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

From: "Jeff Rizzo" <riz@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/46814 CVS commit: [netbsd-6] src/share/man/man3
Date: Mon, 3 Sep 2012 18:41:15 +0000

 Module Name:	src
 Committed By:	riz
 Date:		Mon Sep  3 18:41:15 UTC 2012

 Modified Files:
 	src/share/man/man3 [netbsd-6]: rbtree.3

 Log Message:
 Pull up following revision(s) (requested by dholland in ticket #526):
 	share/man/man3/rbtree.3: revision 1.7
 Add more function argument names to the man page, trying to address
 PR 46814 by Lloyd Parkes. Bump date.


 To generate a diff of this commit:
 cvs rdiff -u -r1.5 -r1.5.6.1 src/share/man/man3/rbtree.3

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

>Unformatted:

Home	PR Database Search