diff options
| author | Donald Sharp <sharpd@nvidia.com> | 2024-05-31 12:03:22 -0400 |
|---|---|---|
| committer | Donald Sharp <sharpd@nvidia.com> | 2024-06-19 07:49:53 -0400 |
| commit | 69b36cdf071a83f57a10206fd69db6cc7da5d10f (patch) | |
| tree | 32096765d77f15d021602e9e35dc29b0c144d105 /lib/openbsd-tree.h | |
| parent | 64112ed9e65eacd9a706d59fd1345ae64ee6c4a4 (diff) | |
lib: Discourage usage of deprecated data structures
Put some verbiage in place to warn people that we
are actively discouraging new development that uses
an older data structure.
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
Diffstat (limited to 'lib/openbsd-tree.h')
| -rw-r--r-- | lib/openbsd-tree.h | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/openbsd-tree.h b/lib/openbsd-tree.h index 4f3985bbca..ecc3a68f15 100644 --- a/lib/openbsd-tree.h +++ b/lib/openbsd-tree.h @@ -10,6 +10,21 @@ #ifdef __cplusplus extern "C" { #endif +/* + * NOTICE: + * + * If you are reading this file in an effort to add a new tree structure + * this is the wrong place to be using it. Please see the typesafe + * data structures, or ask one of the other developers. + * + * If you are reading this file as a way to update an existing usage + * of this data structure, please consider just converting the data + * structure to one of the typesafe data structures instead. However, + * among converting datastrucutres, the the BSD ones are the lowest + * priority / should be converted last. They are already typesafe and + * use inline linking nodes, so the only gain is consistency. Please + * convert uses of linklist.h and hash.h first. + */ /* * This file defines data structures for different types of trees: |