From: Francis Deslauriers <francis.deslauriers@efficios.com>
Date: Wed, 18 Dec 2019 21:40:49 +0000 (-0500)
Subject: Docs: explain why unused `lttng_enabler::ctx` is kept around
X-Git-Tag: v2.13.0-rc1~156
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=2954b37c7e2100dd7ddb3cdd81b67f4cb692524f;p=lttng-modules.git

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 72a12857..a8a39a60 100644
--- 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;
 };