From: Francis Deslauriers <francis.deslauriers@efficios.com>
Date: Wed, 18 Dec 2019 21:46:21 +0000 (-0500)
Subject: Docs: explain why unused `lttng_enabler::ctx` is kept around
X-Git-Tag: v2.13.0-rc1~541
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=416165a551d37c6501034a30401da626f3b6acff;p=lttng-ust.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: I93cc035ced57e29f3d675c8c611d5319194e6cfb
---

diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h
index 905dbb6a..c1a85173 100644
--- 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;
 };