]> git.proxmox.com Git - mirror_frr.git/commit - lib/hash.h
lib: Update hash.h documentation
authorDonald Sharp <sharpd@cumulusnetworks.com>
Wed, 15 Aug 2018 19:50:30 +0000 (15:50 -0400)
committerDonald Sharp <sharpd@cumulusnetworks.com>
Wed, 15 Aug 2018 21:53:09 +0000 (17:53 -0400)
commitd3ce24ef578a95e3c8ae01c0a9c5a3545f59bd62
tree2726ae9b9bbbd07bceed15045bf43f1a386323c8
parentf5bffa5a7435696780d8a7f1ebe842e4cd7b3af4
lib: Update hash.h documentation

The hash_get function when called and the alloc_func returns
a NULL value, we do not create a backet nor do we insert
anything into the hash.  As such backet->data must always
be non-NULL.

Modify the description in hash_get to inform of this.
Additionally indicate that hash_walk and hash_iterate
cannot have a NULL backet->data value.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
lib/hash.h