Docs: document trigger condition and action ownership in 2.13+

[lttng-tools.git] / include / lttng / trigger / trigger.h

diff --git a/include/lttng/trigger/trigger.h b/include/lttng/trigger/trigger.h
index 5fef53fd415f15e69b859f48e9e1ce947f291fb9..3b1cedda1fb4709457537ded9df978e206d6d3ca 100644 (file)
--- a/include/lttng/trigger/trigger.h
+++ b/include/lttng/trigger/trigger.h
@@ -49,8 +49,14 @@ enum lttng_trigger_firing_policy {
  * in the emission of a notification to clients listening through
  * notification channels.
  *
- * The caller retains the ownership of both the condition and action
- * and both must be kept alive for the lifetime of the trigger object.
+ * Prior to 2.13, the caller had to retain the ownership of both the condition
+ * and action. Both objects had to be kept alive for the lifetime of the trigger
+ * object. This is no longer the case as the condition and action objects are
+ * internally reference counted. It is safe to destroy a condition and an action
+ * after using them to create a trigger. However, they should no longer be used.
+ *
+ * If the action is a notification action with capture descriptors,
+ * the condition must be an event rule condition.
  *
  * A trigger must be registered in order to become activate and can
  * be destroyed after its registration.