Docs: CTF-IR sequence's length field must be unsigned

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

diff --git a/formats/ctf/ir/event-fields.c b/formats/ctf/ir/event-fields.c
index 973c9bdd395338bbc5370355393dd61a374fd85c..a6054859690cb2f1a2f24cb259410a8744fe50d4 100644 (file)
--- a/formats/ctf/ir/event-fields.c
+++ b/formats/ctf/ir/event-fields.c
@@ -269,6 +269,7 @@ int bt_ctf_field_sequence_set_length(struct bt_ctf_field *field,
 
        length_type = container_of(length_field->type,
                struct bt_ctf_field_type_integer, parent);
+       /* The length field must be unsigned */
        if (length_type->declaration.signedness) {
                ret = -1;
                goto end;

diff --git a/include/babeltrace/ctf-ir/event-fields.h b/include/babeltrace/ctf-ir/event-fields.h
index c617dac2c11130d233c30fd090a66e604bd398d0..332d7d473ef05edcbd3e696b1a723c2edc4cc9ec 100644 (file)
--- a/include/babeltrace/ctf-ir/event-fields.h
+++ b/include/babeltrace/ctf-ir/event-fields.h
@@ -116,7 +116,8 @@ extern struct bt_ctf_field *bt_ctf_field_sequence_get_length(
  * Set the sequence's length field.
  *
  * @param sequence Sequence field instance.
- * @param length_field Integer field instance indicating the sequence's length.
+ * @param length_field Unsigned integer field instance indicating the
+ *        sequence's length.
  *
  * Returns 0 on success, a negative value on error.
  */