Docs: relayd: document the semantics of a viewer session trace chunk

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

diff --git a/src/bin/lttng-relayd/viewer-session.h b/src/bin/lttng-relayd/viewer-session.h
index 2a685f948f15df365f6bb7bf3ee60a8715000379..f70daed7ba5940617c6a834864575e92d1f54822 100644 (file)
--- a/src/bin/lttng-relayd/viewer-session.h
+++ b/src/bin/lttng-relayd/viewer-session.h
@@ -53,6 +53,10 @@ struct relay_viewer_session {
         * most recent trace chunk available _even if its streams do not point to
         * it_. It indicates which trace chunk viewer streams should transition
         * to when the end of their current trace chunk is reached.
+        *
+        * Note that a viewer session's trace chunk points to the session's
+        * output directory. The sub-directories in which the various stream files
+        * are created are considered as being a part of their name.
         */
        struct lttng_trace_chunk *current_trace_chunk;
 };