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: If2c6b9203ea324bb1ff4051b0a705e7303dbf3a6

diff --git a/include/lttng/events.h b/include/lttng/events.h
index 72a12857c7cf038c7a4a65e188279f20876570b3..a8a39a60c33c9c92b9aab1d86ccc1dbfbda1f6b9 100644 (file)
--- a/include/lttng/events.h
+++ b/include/lttng/events.h
@@ -347,6 +347,10 @@ struct lttng_enabler {
 
        struct lttng_kernel_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;
 };