doc/man: make default values of boolean init. params. clearer

[babeltrace.git] / doc / man / babeltrace2-source.ctf.fs.7.txt

diff --git a/doc/man/babeltrace2-source.ctf.fs.7.txt b/doc/man/babeltrace2-source.ctf.fs.7.txt
index f05a4d10b9ae4cca674b35885006f874d8d98dbf..15ab96e40367cd46cf724d81b3b9af0d2783c846 100644 (file)
--- a/doc/man/babeltrace2-source.ctf.fs.7.txt
+++ b/doc/man/babeltrace2-source.ctf.fs.7.txt
@@ -1,6 +1,6 @@
 = babeltrace2-source.ctf.fs(7)
 :manpagetype: component class
-:revdate: 14 September 2019
+:revdate: 1 September 2023
 
 
 == NAME
@@ -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
 
@@ -136,9 +144,12 @@ param:clock-class-offset-s='SEC' vtype:[optional signed integer]::
 You can combine this parameter with the param:clock-class-offset-ns
 parameter.
 
-param:force-clock-class-origin-unix-epoch=`yes` vtype:[optional boolean]::
-    Force the origin of all clock classes that the component creates to
-    have a Unix epoch origin, whatever the detected tracer.
+param:force-clock-class-origin-unix-epoch='VAL' vtype:[optional boolean]::
+    If 'VAL' is true, then force the origin of all clock classes that
+    the component creates to have a Unix epoch origin, whatever the
+    detected tracer.
++
+Default: false.
 
 param:inputs='DIRS' vtype:[array of strings]::
     Open and read the physical CTF traces located in 'DIRS'.