Docs: explain why unused `lttng_enabler::ctx` is kept around

[lttng-ust.git] / include / lttng / ust-events.h

diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h
index a9f80fb01e3b45faad3d5cf2da1fdf416a731f57..c1a851731a006eebfdf4fced1596d80d36df27fc 100644 (file)
--- a/include/lttng/ust-events.h
+++ b/include/lttng/ust-events.h
@@ -366,6 +366,10 @@ struct lttng_enabler {
 
        struct lttng_ust_event event_param;
        struct lttng_channel *chan;
+       /*
+        * Unused, but kept around to make it explicit that the tracer can do
+        * it.
+        */
        struct lttng_ctx *ctx;
        unsigned int enabled:1;
 };
@@ -752,7 +756,6 @@ void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
 struct lttng_ust_field_iter *
        lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
 
-void lttng_filter_event_link_bytecode(struct lttng_event *event);
 void lttng_enabler_event_link_bytecode(struct lttng_event *event,
                struct lttng_enabler *enabler);
 void lttng_free_event_filter_runtime(struct lttng_event *event);
@@ -775,6 +778,7 @@ void lttng_ust_fixup_fd_tracker_tls(void);
 extern struct lttng_ctx *lttng_static_ctx;
 void lttng_context_init(void);
 void lttng_context_exit(void);
+void lttng_filter_event_link_bytecode(struct lttng_event *event);
 
 #ifdef __cplusplus
 }