X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng-relayd%2Fsessiond-trace-chunks.h;fp=src%2Fbin%2Flttng-relayd%2Fsessiond-trace-chunks.h;h=2c771d8094fe172628bd41b8ecea38af7dca2bdd;hp=f2bc5a3825163780412dfdb51165969697f44eec;hb=72c696e8fb82949915fe107851169fdea87ae8bc;hpb=985aea182b618c85c51651f224abedfe367c75ee

diff --git a/src/bin/lttng-relayd/sessiond-trace-chunks.h b/src/bin/lttng-relayd/sessiond-trace-chunks.h
index f2bc5a382..2c771d809 100644
--- a/src/bin/lttng-relayd/sessiond-trace-chunks.h
+++ b/src/bin/lttng-relayd/sessiond-trace-chunks.h
@@ -12,6 +12,17 @@
 #include <common/trace-chunk.h>
 #include <stdint.h>
 
+/*
+ * A session trace chunk registry allows the relay daemon to share trace chunks
+ * used by different "relay sessions" when they were created for the same
+ * user-visible session daemon session. Tracing multiple domains (e.g. ust and
+ * kernel) results in per-domain relay sessions being created.
+ *
+ * Sharing trace chunks, and their output directory more specifically, is
+ * essential to properly implement session rotations. The sharing of output
+ * directory handles allows directory renames to be performed once and without
+ * races that would stem from from multiple renames.
+ */
 struct sessiond_trace_chunk_registry;
 
 struct sessiond_trace_chunk_registry *