Docs: clarify the meaning of the snapshot_mode flag in ltt_session

[lttng-tools.git] / src / bin / lttng-sessiond / session.h

diff --git a/src/bin/lttng-sessiond/session.h b/src/bin/lttng-sessiond/session.h
index 6a0da6c164f95a48b15a2e0250611d77a0dcf2ec..82e409521c440c621f06d5d46a86d8cc380e6d6c 100644 (file)
--- a/src/bin/lttng-sessiond/session.h
+++ b/src/bin/lttng-sessiond/session.h
@@ -114,9 +114,11 @@ struct ltt_session {
        /* Indicate if the session has to output the traces or not. */
        unsigned int output_traces;
        /*
-        * This session is in snapshot mode. This means that every channel enabled
-        * will be set in overwrite mode and mmap. It is considered exclusively for
-        * snapshot purposes.
+        * This session is in snapshot mode. This means that channels enabled
+        * will be set in overwrite mode by default and must be in mmap
+        * output mode. Note that snapshots can be taken on a session that
+        * is not in "snapshot_mode". This parameter only affects channel
+        * creation defaults.
         */
        unsigned int snapshot_mode;
        /*