Document that payload size need to be greater than 0

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/lib/ringbuffer/config.h b/lib/ringbuffer/config.h
index 657c04d224a431ef41c7627aaf41a494072304c8..67caba0646acffcfa1b99c354f8f1dc7dccc3980 100644 (file)
--- a/lib/ringbuffer/config.h
+++ b/lib/ringbuffer/config.h
@@ -207,7 +207,7 @@ struct lib_ring_buffer_ctx {
  * @ctx: ring buffer context to initialize
  * @chan: channel
  * @priv: client private data
- * @data_size: size of record data payload
+ * @data_size: size of record data payload. It must be greater than 0.
  * @largest_align: largest alignment within data payload types
  * @cpu: processor id
  */