X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=bindings%2Fpython%2Fbabeltrace.i.in;h=5142952ec5fdeac715a28e01510354b29ed68f07;hp=5a06f0ba4639db4ca12a76723b5c5198e5779be9;hb=19ae15ed55fb6857ff469b60a3f3cbe32590c6e2;hpb=e11b8d3a38c016ebbbc849e2b1aabf0a80a28ce4

diff --git a/bindings/python/babeltrace.i.in b/bindings/python/babeltrace.i.in
index 5a06f0ba..5142952e 100644
--- a/bindings/python/babeltrace.i.in
+++ b/bindings/python/babeltrace.i.in
@@ -211,6 +211,17 @@ class TraceCollection:
 		"""
 		Generator function to iterate over the events of open in the current
 		TraceCollection.
+
+		Due to limitations of the native Babeltrace API, only one event
+		may be "alive" at a time (i.e. a user should never store a copy
+		of the events returned by this function for ulterior use). Users
+		shall make sure to copy the information they need from an event
+		before accessing the next one.
+
+		Furthermore, event objects become invalid when the generator goes
+		out of scope as the underlying iterator will be reclaimed. Using an
+		event after the the generator has gone out of scope may result in a
+		crash or data corruption.
 		"""
 		begin_pos_ptr = _bt_iter_pos()
 		end_pos_ptr = _bt_iter_pos()