change(docs): Move the trivial type limitation notice to the README

README.md

@@ -43,6 +43,9 @@ On embedded systems, ```LOCKFREE_CACHE_COHERENT``` should almost always be set a
 
 Additionally, some systems have a non-typical cacheline length (for instance the apple M1/M2 CPUs have a cacheline length of 128 bytes), and ```LOCKFREE_CACHELINE_LENGTH``` should be set accordingly in those cases.
 
+## Known limitations
+All of the data structures in `lockfree` are only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
+
 ## FAQ
 ### Why would I use this over locking data structures on a hosted machine?
 

docs/mpmc/priority_queue.md

@@ -3,8 +3,6 @@
 ## When to use the Priority Queue
 The Priority Queue should be used when there are distinct priorities between elements to be enqueued, for instance different urgency signals between threads or packets of different priorities.
 
-> Note: At the moment, the Queue is only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
-
 ## How to use
 Shown here is an example of typical use:
 * Initialization

docs/mpmc/queue.md

@@ -3,8 +3,6 @@
 ## When to use the Queue
 The Queue is the simplest data structure in the library, and it should be used when single element operations are dominant. It has the simplest API and lowest overhead per operation.
 
-> Note: At the moment, the Queue is only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
-
 ## How to use
 Shown here is an example of typical use:
 * Initialization

docs/spsc/bipartite_buf.md

@@ -7,8 +7,6 @@ A bipartite buffer should be used everywhere the Ring Buffer is used if you want
 * To process data inside the buffer without dequeueing it
 * When operations on data can fail or only some of the data is used
 
-> Note: At the moment, the Bipartite Buffer is only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
-
 ## How to use
 Shown here is an example of typical use:
 * Initialization

docs/spsc/priority_queue.md

@@ -3,8 +3,6 @@
 ## When to use the Priority Queue
 The Priority Queue should be used when there are distinct priorities between elements to be enqueued, for instance different urgency signals between threads or packets of different priorities.
 
-> Note: At the moment, the Queue is only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
-
 ## How to use
 Shown here is an example of typical use:
 * Initialization

docs/spsc/queue.md

@@ -3,8 +3,6 @@
 ## When to use the Queue
 Queue is the simplest data structure in the library, and it should be used when single element operations are dominant. It has the simplest API and lowest overhead per operation.
 
-> Note: At the moment, the Queue is only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
-
 ## How to use
 Shown here is an example of typical use:
 * Initialization

docs/spsc/ring_buf.md

@@ -5,8 +5,6 @@
 * For byte streams where variably sized packets need to be enqueued but sent `n` bytes at a time
 * When operations on data can fail or only some of the data is used
 
-> Note: At the moment, the Ring Buffer is only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
-
 ## How to use
 There are three API types that can be used:
 * A raw pointer and element count API