summaryrefslogtreecommitdiff
path: root/lib/linklist.h
diff options
context:
space:
mode:
authorDonald Sharp <sharpd@nvidia.com>2024-05-31 12:03:22 -0400
committerDonald Sharp <sharpd@nvidia.com>2024-06-19 07:49:53 -0400
commit69b36cdf071a83f57a10206fd69db6cc7da5d10f (patch)
tree32096765d77f15d021602e9e35dc29b0c144d105 /lib/linklist.h
parent64112ed9e65eacd9a706d59fd1345ae64ee6c4a4 (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/linklist.h')
-rw-r--r--lib/linklist.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/linklist.h b/lib/linklist.h
index fd953d0769..f922891df9 100644
--- a/lib/linklist.h
+++ b/lib/linklist.h
@@ -10,6 +10,18 @@
extern "C" {
#endif
+/*
+ * NOTICE:
+ *
+ * If you are reading this file in an effort to add a new list 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.
+ */
+
/* listnodes must always contain data to be valid. Adding an empty node
* to a list is invalid
*/