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 <[email protected]>
FRRouting · Jun 19, 2024 · 69b36cd · 69b36cd
1 parent 64112ed
commit 69b36cd
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 0 deletions.
diff --git a/lib/hash.h b/lib/hash.h
@@ -13,6 +13,18 @@
 extern "C" {
 #endif
 
+/*
+ * NOTICE:
+ *
+ * If you are reading this file in an effort to add a new hash 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.
+ */
+
 /* Default hash table size.  */
 #define HASH_INITIAL_SIZE 256
 /* Expansion threshold */

diff --git 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
  */

diff --git a/lib/openbsd-queue.h b/lib/openbsd-queue.h
@@ -16,6 +16,22 @@
 extern "C" {
 #endif
 
+/*
+ * NOTICE:
+ *
+ * If you are reading this file in an effort to add a new queue 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 five types of data structures: singly-linked lists,
  * lists, simple queues, tail queues and XOR simple queues.

diff --git 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: