babeltrace2-source.ctf.fs(7): add a "CTF compliance" description section

[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..3156ee542bccaa204427d301447b433496ba0d61 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
 
@@ -120,6 +128,29 @@ barectf up to, but excluding, 2.3.1::
 --
 
 
+=== CTF compliance
+
+A compcls:source.ctf.fs component decodes traces as per
+https://diamon.org/ctf/v1.8.3/[CTF~1.8.3], except:
+
+* It only supports integer field classes (TSDL `integer` block) with
+  sizes from 1 to 64.
+
+* It only supports 32-bit and 64-bit floating point number classes (TSDL
+  `floating_point` block).
+
+* It doesn't support §~4.1.6 (``GNU/C bitfields'').
+
+* It doesn't support TSDL `callsite` blocks: the parser simply ignores
+  them.
+
+* It only supports a single clock class (TSDL `clock` block) reference
+  per stream class (TSDL `stream` block).
+
+* It doesn't support the checksum, compression, and encryption features
+  of metadata stream packets.
+
+
 == INITIALIZATION PARAMETERS
 
 param:clock-class-offset-ns='NS' vtype:[optional signed integer]::