From: Jérémie Galarneau Date: Tue, 16 Dec 2014 22:47:15 +0000 (-0500) Subject: Docs: Indicate that stream event context is sampled on event append X-Git-Tag: v2.0.0-pre1~1443 X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=632e5b3d88abb5f50e1c45efe67d2ccd188c01fc Docs: Indicate that stream event context is sampled on event append Signed-off-by: Jérémie Galarneau --- diff --git a/include/babeltrace/ctf-ir/stream.h b/include/babeltrace/ctf-ir/stream.h index ab0a8c7e..9cf02554 100644 --- a/include/babeltrace/ctf-ir/stream.h +++ b/include/babeltrace/ctf-ir/stream.h @@ -76,6 +76,9 @@ extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, * incrementing its reference count. The current packet is not flushed to disk * until the next call to bt_ctf_stream_flush. * + * The stream event context will be sampled for every appended event if + * a stream event context was defined. + * * @param stream Stream instance. * @param event Event instance to append to the stream's current packet. *