From f7911aa7efbda480d98d17ee5731a65d569db265 Mon Sep 17 00:00:00 2001 From: Mathieu Desnoyers Date: Sat, 27 Apr 2013 12:51:00 -0400 Subject: [PATCH] Documentation: document undefined behavior for NULL pointers Strings, arrays, sequences have undefined behavior if the pointer they receive are NULL. Signed-off-by: Mathieu Desnoyers --- doc/man/lttng-ust.3 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3 index 5be3cfaa..8286e568 100644 --- a/doc/man/lttng-ust.3 +++ b/doc/man/lttng-ust.3 @@ -116,6 +116,7 @@ TRACEPOINT_EVENT( * ctf_array_text: a statically-sized array, printed as * a string. No need to be terminated by a null * character. + * Behavior is undefined if "text" field is NULL. */ ctf_array_text(char, arrfield2, text, 10) @@ -127,6 +128,7 @@ TRACEPOINT_EVENT( * unsigned type. As a reminder, "unsigned char" should * be preferred to "char", since the signedness of * "char" is implementation-defined. + * Behavior is undefined if "text" field is NULL. */ ctf_sequence(char, seqfield1, text, size_t, textlen) @@ -134,6 +136,7 @@ TRACEPOINT_EVENT( /* * ctf_sequence_text: a dynamically-sized array, printed * as string. No need to be null-terminated. + * Behavior is undefined if "text" field is NULL. */ ctf_sequence_text(char, seqfield2, text, size_t, textlen) @@ -141,6 +144,7 @@ TRACEPOINT_EVENT( /* * ctf_string: null-terminated string. * args: (field name, argument expression) + * Behavior is undefined if "text" field is NULL. */ ctf_string(stringfield, text) -- 2.34.1