Module Name: src
Committed By: dholland
Date: Mon Aug 29 03:50:05 UTC 2016
Modified Files:
src/share/man/man3: rbtree.3
Log Message:
Clarify the usage, so hopefully nobody else makes the set of wrong
assumptions I just did.
To generate a diff of this commit:
cvs rdiff -u -r1.10 -r1.11 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.
Modified files:
Index: src/share/man/man3/rbtree.3
diff -u src/share/man/man3/rbtree.3:1.10 src/share/man/man3/rbtree.3:1.11
--- src/share/man/man3/rbtree.3:1.10 Tue Mar 18 18:20:39 2014
+++ src/share/man/man3/rbtree.3 Mon Aug 29 03:50:05 2016
@@ -1,4 +1,4 @@
-.\" $NetBSD: rbtree.3,v 1.10 2014/03/18 18:20:39 riastradh Exp $
+.\" $NetBSD: rbtree.3,v 1.11 2016/08/29 03:50:05 dholland Exp $
.\"
.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -27,7 +27,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd March 13, 2013
+.Dd August 29, 2016
.Dt RBTREE 3
.Os
.Sh NAME
@@ -118,8 +118,8 @@ Defines the operator for comparing two n
the operator for comparing a node in the tree with a key,
the offset of member
.Vt rb_node_t
-within a node,
-and the opaque context passed to the operators.
+within the node type,
+and the opaque context pointer passed to the comparison functions.
Members of
.Vt rb_tree_ops_t
are
@@ -131,6 +131,15 @@ are
.Ed
.It Vt rb_node_t
A node in a red-black tree has this structure as a member.
+The offset of the
+.Vt rb_node_t
+member in the caller's node structure should be provided as
+.Va rbto_node_offset .
+(None of the functions in the
+.Nm
+interface are meant to take pointers directly to the
+.Vt rb_node_t
+member.)
.El
.Sh FUNCTIONS
.Bl -tag -width compact
