Fix: Field types native byte order refers to the trace

[babeltrace.git] / include / babeltrace / ctf-ir / event-types.h

diff --git a/include/babeltrace/ctf-ir/event-types.h b/include/babeltrace/ctf-ir/event-types.h
index d445812f4363292a16ccfd0a01967e9a7d1de7bd..258c7473d66328a599d9ba5bf075512606f2f10c 100644 (file)
--- a/include/babeltrace/ctf-ir/event-types.h
+++ b/include/babeltrace/ctf-ir/event-types.h
@@ -52,6 +52,11 @@ enum bt_ctf_integer_base {
 
 enum bt_ctf_byte_order {
        BT_CTF_BYTE_ORDER_UNKNOWN = -1,
+       /*
+        * Note that native, in the context of the CTF specification, is defined as
+        * "the byte order described in the trace" and does not mean that the host's
+        * endianness will be used.
+        */
        BT_CTF_BYTE_ORDER_NATIVE = 0,
        BT_CTF_BYTE_ORDER_LITTLE_ENDIAN,
        BT_CTF_BYTE_ORDER_BIG_ENDIAN,
@@ -695,7 +700,7 @@ extern enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order(
  *
  * @param type Field type.
  * @param byte_order Field type's byte order. Defaults to
- * BT_CTF_BYTE_ORDER_NATIVE, the host machine's endianness.
+ * BT_CTF_BYTE_ORDER_NATIVE; the trace's endianness.
  *
  * Returns 0 on success, a negative value on error.
  */