From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Thu, 12 Mar 2020 17:33:09 +0000 (-0400)
Subject: doc: bt_field_class...get_mapping_labels...(): clarify RV's validity
X-Git-Url: http://git.efficios.com/?a=commitdiff_plain;h=45397ca4f49f5d93e0c2c178d68d37224a8a9d47;hp=45397ca4f49f5d93e0c2c178d68d37224a8a9d47;p=babeltrace.git

doc: bt_field_class...get_mapping_labels...(): clarify RV's validity

The label array which
bt_field_class_enumeration_unsigned_get_mapping_labels_for_value() and
bt_field_class_enumeration_signed_get_mapping_labels_for_value() return
remains valid as long as:

* The enumeration field class is not modified.

* You don't call the same function again with the same enumeration
  field class.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I7b197ab5e176c77f4418d23b12e194c6477e5cf8
Reviewed-on: https://review.lttng.org/c/babeltrace/+/3224
---