From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Mon, 17 Sep 2018 22:15:11 +0000 (-0400)
Subject: Docs: document the meaning of a ust app channel key set to 0
X-Git-Tag: v2.10.6~22
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=4a732689c2fe7624efff6fec2353542f14c60cb8;p=lttng-tools.git

Docs: document the meaning of a ust app channel key set to 0

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/src/bin/lttng-sessiond/ust-app.h b/src/bin/lttng-sessiond/ust-app.h
index 03a50e877..3c375f30d 100644
--- a/src/bin/lttng-sessiond/ust-app.h
+++ b/src/bin/lttng-sessiond/ust-app.h
@@ -134,7 +134,11 @@ struct ust_app_channel {
 	int handle;
 	/* Channel and streams were sent to the UST tracer. */
 	int is_sent;
-	/* Unique key used to identify the channel on the consumer side. */
+	/*
+	 * Unique key used to identify the channel on the consumer side.
+	 * 0 is a reserved 'invalid' value used to indicate that the consumer
+	 * does not know about this channel (i.e. an error occured).
+	 */
 	uint64_t key;
 	/* Id of the tracing channel set on creation. */
 	uint64_t tracing_channel_id;