From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Mon, 15 Dec 2014 00:29:17 +0000 (-0500)
Subject: Docs: Add a comment about event validation in bt_ctf_stream_append_event
X-Git-Tag: v2.0.0-pre1~1447
X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=785b539083d6cc763da4c70cf94bed50836f80f6

Docs: Add a comment about event validation in bt_ctf_stream_append_event

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/formats/ctf/ir/stream.c b/formats/ctf/ir/stream.c
index 5cf7eab3..32930602 100644
--- a/formats/ctf/ir/stream.c
+++ b/formats/ctf/ir/stream.c
@@ -283,6 +283,7 @@ int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
 		goto end;
 	}
 
+	/* Make sure the event's payload is set */
 	ret = bt_ctf_event_validate(event);
 	if (ret) {
 		goto end;