summaryrefslogtreecommitdiff
path: root/lib/openbsd-queue.h
diff options
context:
space:
mode:
authorDavid Lamparter <equinox@opensourcerouting.org>2024-07-10 09:08:21 +0200
committerGitHub <noreply@github.com>2024-07-10 09:08:21 +0200
commitebf05b4ee18a94086a15207f14b00b05df5a5dde (patch)
treead228433978fdb66b834c0d9ea245181340ddf63 /lib/openbsd-queue.h
parent52376aa4b6244f39e6edf82b3d3827e33d965cf9 (diff)
parent69b36cdf071a83f57a10206fd69db6cc7da5d10f (diff)
Merge pull request #16140 from donaldsharp/linklist_discouragement
Diffstat (limited to 'lib/openbsd-queue.h')
-rw-r--r--lib/openbsd-queue.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/lib/openbsd-queue.h b/lib/openbsd-queue.h
index df3bbd720f..a2df521f58 100644
--- a/lib/openbsd-queue.h
+++ b/lib/openbsd-queue.h
@@ -17,6 +17,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.
*