git: 08349b18ea26 - main - tree.3: explain RB_FIND() and RB_NFIND()

The branch main has been updated by kib:

URL: https://cgit.FreeBSD.org/src/commit/?id=08349b18ea26d1e191333f9b3550cd95b09cfe34

commit 08349b18ea26d1e191333f9b3550cd95b09cfe34
Author:     Konstantin Belousov <kib@FreeBSD.org>
AuthorDate: 2022-08-01 09:43:10 +0000
Commit:     Konstantin Belousov <kib@FreeBSD.org>
CommitDate: 2022-08-07 19:23:44 +0000

    tree.3: explain RB_FIND() and RB_NFIND()
    
    In collaboration with:  dougm
    Reviewed by:    alc
    Sponsored by:   The FreeBSD Foundation (kib)
    MFC after:      3 days
    Differential revision:  https://reviews.freebsd.org/D36001
---
 share/man/man3/tree.3 | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/share/man/man3/tree.3 b/share/man/man3/tree.3
index 08d442db5e78..7e3727b2c365 100644
--- a/share/man/man3/tree.3
+++ b/share/man/man3/tree.3
@@ -523,10 +523,25 @@ The
 and
 .Fn RB_NFIND
 macros can be used to find a particular element in the tree.
+.Pp
+The
+.Fn RB_FIND
+macro returns the element in the tree equal to the provided
+key, or
+.Dv NULL
+if there is no such element.
+.Pp
+The
+.Fn RB_NFIND
+macro returns the least element greater than or equal to the provided
+key, or
+.Dv NULL
+if there is no such element.
 .Bd -literal -offset indent
-struct TYPE find, *res;
+struct TYPE find, *res, *resn;
 find.key = 30;
 res = RB_FIND(NAME, head, &find);
+resn = RB_NFIND(NAME, head, &find);
 .Ed
 .Pp
 The