From 18fcd1c9a2c2ac031c2269cb2cb1b142beb2f233 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Thu, 1 Dec 2016 17:03:10 -0500 Subject: [PATCH] field-types.h: doc: add note about freezing MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- include/babeltrace/ctf-ir/field-types.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/include/babeltrace/ctf-ir/field-types.h b/include/babeltrace/ctf-ir/field-types.h index f7b47a492..87ef95788 100644 --- a/include/babeltrace/ctf-ir/field-types.h +++ b/include/babeltrace/ctf-ir/field-types.h @@ -174,6 +174,9 @@ The following functions can \em freeze field type objects: - bt_ctf_event_create() freezes the root field types of its event class parameter and of ther parent stream class of this event class. +You cannot modify a frozen field type object: it is considered +immutable, except for \link refs reference counting\endlink. + @sa ctfirfields @file -- 2.34.1