From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Wed, 10 Apr 2013 00:40:12 +0000 (-0400)
Subject: Documentation: document that sequence len field is unsigned
X-Git-Tag: v2.2.0-rc2~14
X-Git-Url: http://git.lttng.org/?a=commitdiff_plain;h=efbad5cc87395d00fa1d578ae211aee431fa3b4a;p=lttng-ust.git

Documentation: document that sequence len field is unsigned

Fixes #471

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

diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
index 5effb9f5..5be3cfaa 100644
--- a/doc/man/lttng-ust.3
+++ b/doc/man/lttng-ust.3
@@ -123,6 +123,10 @@ TRACEPOINT_EVENT(
 		 * ctf_sequence: a dynamically-sized array.
 		 * args: (type, field name, argument expression,
 		 *	type of length expression, length expression)
+		 * The "type of length expression" needs to be an
+		 * unsigned type. As a reminder, "unsigned char" should
+		 * be preferred to "char", since the signedness of
+		 * "char" is implementation-defined.
 		 */ 
 		ctf_sequence(char, seqfield1, text,
 			     size_t, textlen)