From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Wed, 26 Jun 2013 17:54:18 +0000 (-0400)
Subject: Document that payload size need to be greater than 0
X-Git-Tag: v2.3.0-rc1~23
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=3cae7f221dc4fba025901949023238975bb59b78;p=lttng-modules.git

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 657c04d2..67caba06 100644
--- 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
  */