Documentation: document that sequence len field is unsigned

[lttng-ust.git] / doc / man / lttng-ust.3

diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
index 0738c5bce3ceb68902305978564fc49395286441..5be3cfaa081a669cb8d9b9e990117dd63f9bc735 100644 (file)
--- a/doc/man/lttng-ust.3
+++ b/doc/man/lttng-ust.3
@@ -1,7 +1,7 @@
 .TH "LTTNG-UST" "3" "February 16, 2012" "" ""
 
 .SH "NAME"
-lttng-ust \(em Linux Trace Toolkit Next Generation User-Space Tracer
+lttng-ust \(em Linux Trace Toolkit Next Generation User-Space Tracer 2.x
 
 .SH "SYNOPSIS"
 
@@ -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)