babeltrace2-source.ctf.fs(7): document the overlapping snapshot feature

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I482a366679f65a577cb7081ce46736ab484858c3
Reviewed-on: https://review.lttng.org/c/babeltrace/+/2395

diff --git a/doc/man/babeltrace2-source.ctf.fs.7.txt b/doc/man/babeltrace2-source.ctf.fs.7.txt
index f05a4d10b9ae4cca674b35885006f874d8d98dbf..fe3ff3222b128a20c32d3032adc1ec14f8244019 100644 (file)
--- a/doc/man/babeltrace2-source.ctf.fs.7.txt
+++ b/doc/man/babeltrace2-source.ctf.fs.7.txt
@@ -67,6 +67,14 @@ More than one physical CTF data stream file can support a single logical
 CTF data stream (LTTng's trace file rotation and tracing session
 rotation can cause this).
 
+If two or more data stream files contain the same packets, a
+compcls:source.ctf.fs message iterator reads each of  them only once so
+that it never emits duplicated messages. This feature makes it possible,
+for example, to open overlapping
+https://lttng.org/docs/#doc-taking-a-snapshot[LTTng snapshots] with a
+single compcls:source.ctf.fs component and silently discard the
+duplicated packets.
+
 
 === Trace quirks