diff options
| author | Nicholas Marriott <nicm@cvs.openbsd.org> | 2010-05-05 18:17:42 +0000 |
|---|---|---|
| committer | Nicholas Marriott <nicm@cvs.openbsd.org> | 2010-05-05 18:17:42 +0000 |
| commit | 9f37e35c559a5a2e807f7bfe6f18ec0d08fe3dd5 (patch) | |
| tree | 629276e01756168d43f15925f009bc6d5eeb83ab /share | |
| parent | e7bc0cd4082c9bab9354a84d22edcc251fc97c62 (diff) | |
Move the return values of RB_INSERT, RB_REMOVE, SPLAY_INSERT and
SPLAY_REMOVE closer to whether the macros are documents rather than in a
separate section. Also describe the actual return values of the remove
macros.
Tweaked version of a diff from Tim van der Molen.
ok jmc henning
Diffstat (limited to 'share')
| -rw-r--r-- | share/man/man3/tree.3 | 34 |
1 files changed, 15 insertions, 19 deletions
diff --git a/share/man/man3/tree.3 b/share/man/man3/tree.3 index ffb39ef78f5..99f8f1345ad 100644 --- a/share/man/man3/tree.3 +++ b/share/man/man3/tree.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tree.3,v 1.20 2009/01/28 12:22:48 stsp Exp $ +.\" $OpenBSD: tree.3,v 1.21 2010/05/05 18:17:41 nicm Exp $ .\"/* .\" * Copyright 2002 Niels Provos <provos@citi.umich.edu> .\" * All rights reserved. @@ -23,7 +23,7 @@ .\" * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" */ -.Dd $Mdocdate: January 28 2009 $ +.Dd $Mdocdate: May 5 2010 $ .Dt TREE 3 .Os .Sh NAME @@ -258,6 +258,11 @@ The macro inserts the new element .Fa elm into the tree. +Upon success, +.Va NULL +is returned. +If a matching element already exists in the tree, the insertion is +aborted, and a pointer to the existing element is returned. .Pp The .Fn SPLAY_REMOVE @@ -265,6 +270,11 @@ macro removes the element .Fa elm from the tree pointed by .Fa head . +Upon success, a pointer to the removed element is returned. +.Va NULL +is returned if +.Fa elm +is not present in the tree. .Pp The .Fn SPLAY_FIND @@ -405,6 +415,9 @@ macro removes the element .Fa elm from the tree pointed by .Fa head . +.Fn RB_REMOVE +returns +.Fa elm . .Pp The .Fn RB_FIND @@ -543,22 +556,5 @@ for (var = SPLAY_MIN(NAME, &head); var != NULL; var = nxt) { free(var); } .Ed -.Pp -Both -.Fn RB_INSERT -and -.Fn SPLAY_INSERT -return -.Va NULL -if the element was inserted in the tree successfully, otherwise they -return a pointer to the element with the colliding key. -.Pp -Accordingly, -.Fn RB_REMOVE -and -.Fn SPLAY_REMOVE -return the pointer to the removed element, otherwise they return -.Va NULL -to indicate an error. .Sh AUTHORS The author of the tree macros is Niels Provos. |