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

Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Change-Id: I93cc035ced57e29f3d675c8c611d5319194e6cfb

diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h
index 905dbb6a661fe66c82ae04c03272eab8ded24b90..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;
 
        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;
 };
        struct lttng_ctx *ctx;
        unsigned int enabled:1;
 };