From eb9c98315707b3ff634dee77962d66d5d36ddb85 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Thu, 23 Jul 2020 14:16:29 -0400 Subject: [PATCH] babeltrace2-source.ctf.fs(7): add a "CTF compliance" description section MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit This new section states that `src.ctf.fs` complies with CTF 1.8.3. It also lists a few exceptions/limitations. Signed-off-by: Philippe Proulx Change-Id: I45dc9d6c63fc17f1660ddf9359e83da9e1967df3 Reviewed-on: https://review.lttng.org/c/babeltrace/+/3809 Reviewed-by: Jérémie Galarneau --- doc/man/babeltrace2-source.ctf.fs.7.txt | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/doc/man/babeltrace2-source.ctf.fs.7.txt b/doc/man/babeltrace2-source.ctf.fs.7.txt index fe3ff322..3156ee54 100644 --- a/doc/man/babeltrace2-source.ctf.fs.7.txt +++ b/doc/man/babeltrace2-source.ctf.fs.7.txt @@ -128,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]:: -- 2.34.1