field-types.h: doc: add note about freezing

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/include/babeltrace/ctf-ir/field-types.h b/include/babeltrace/ctf-ir/field-types.h
index f7b47a49225300f127b3b44ff47a8c747277c3a5..87ef957886307bb9b1d1215e8516f5177198d057 100644 (file)
--- 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