From: Philippe Proulx Date: Thu, 1 Dec 2016 22:03:10 +0000 (-0500) Subject: field-types.h: doc: add note about freezing X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=18fcd1c9a2c2ac031c2269cb2cb1b142beb2f233;p=deliverable%2Fbabeltrace.git field-types.h: doc: add note about freezing Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- 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