ir: make bt_ctf_trace_create() create an empty packet header FT

[babeltrace.git] / include / babeltrace / ctf-ir / trace.h

diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h
index df5d34b705c101627736258616bcef8cc6fde561..feb5a6de493a60dd5b0d04a2d2d9630ea7a21bb4 100644 (file)
--- a/include/babeltrace/ctf-ir/trace.h
+++ b/include/babeltrace/ctf-ir/trace.h
@@ -62,7 +62,7 @@ You can obtain a trace class in two different modes:
 A trace class has the following properties:
 
 - A \b name.
-- A <strong>default byte order</strong>: all the
+- A <strong>native byte order</strong>: all the
   \link ctfirfieldtypes field types\endlink eventually part of the trace
   class with a byte order set to #BT_CTF_BYTE_ORDER_NATIVE have this
   "real" byte order.
@@ -124,11 +124,6 @@ except for:
 - Adding a CTF IR clock class to it with bt_ctf_trace_add_clock_class().
 - \link refs Reference counting\endlink.
 
-You can add a custom listener with bt_ctf_trace_add_listener() to get
-notified if anything changes in a trace class, that is, if an event
-class is added to one of its stream class, if a stream class is added,
-or if a clock class is added.
-
 @sa ctfirstreamclass
 @sa ctfireventclass
 @sa ctfirclockclass
@@ -160,24 +155,21 @@ struct bt_ctf_clock_class;
 @brief Creates a default CTF IR trace class.
 
 On success, the trace packet header field type of the created trace
-class has the following fields:
-
-- <code>magic</code>: a 32-bit unsigned integer field type.
-- <code>uuid</code>: an array field type of 16 8-bit unsigned integer
-  field types.
-- <code>stream_id</code>: a 32-bit unsigned integer field type.
-
-You can modify this default trace packet header field type after the
-trace class is created with bt_ctf_trace_set_packet_header_type().
+class is an empty structure field type. You can modify this default
+trace packet header field type after the trace class is created with
+bt_ctf_trace_get_packet_header_type() and
+bt_ctf_trace_set_packet_header_type().
 
 The created trace class has the following initial properties:
 
 - <strong>Name</strong>: none. You can set a name
   with bt_ctf_trace_set_name().
-- <strong>Default byte order</strong>: #BT_CTF_BYTE_ORDER_NATIVE. You
-  can set a default byte order with bt_ctf_trace_set_native_byte_order().
+- <strong>UUID</strong>: none. You can set a UUID with
+  bt_ctf_trace_set_uuid().
+- <strong>Native byte order</strong>: #BT_CTF_BYTE_ORDER_NATIVE. You
+  can set a native byte order with bt_ctf_trace_set_native_byte_order().
 
-  Note that you \em must set the default byte order if any field type
+  Note that you \em must set the native byte order if any field type
   contained in the created trace class, in its stream classes, or in
   its event classes, has a byte order set to #BT_CTF_BYTE_ORDER_NATIVE.
 - <strong>Environment</strong>: empty. You can add environment entries
@@ -236,25 +228,25 @@ extern int bt_ctf_trace_set_name(struct bt_ctf_trace *trace_class,
                const char *name);
 
 /**
-@brief Returns the default byte order of the CTF IR trace class
+@brief Returns the native byte order of the CTF IR trace class
        \p trace_class.
 
 @param[in] trace_class Trace class of which to get the default byte
                        order.
-@returns               Default byte order of trace class
-                       \p trace_class, or #BT_CTF_BYTE_ORDER_UNKNOWN
-                       on error.
+@returns               Native byte order of \p trace_class,
+                       or #BT_CTF_BYTE_ORDER_UNKNOWN on error.
 
 @prenotnull{trace_class}
 @postrefcountsame{trace_class}
 
-@sa bt_ctf_trace_set_name(): Sets the name of a given trace class.
+@sa bt_ctf_trace_set_native_byte_order(): Sets the native byte order of
+       a given trace class.
 */
-extern enum bt_ctf_byte_order bt_ctf_trace_get_byte_order(
+extern enum bt_ctf_byte_order bt_ctf_trace_get_native_byte_order(
                struct bt_ctf_trace *trace_class);
 
 /**
-@brief Sets the default byte order of the CTF IR trace class
+@brief Sets the native byte order of the CTF IR trace class
        \p trace_class to \p native_byte_order.
 
 \p native_byte_order \em must be one of:
@@ -263,20 +255,20 @@ extern enum bt_ctf_byte_order bt_ctf_trace_get_byte_order(
 - #BT_CTF_BYTE_ORDER_BIG_ENDIAN
 - #BT_CTF_BYTE_ORDER_NETWORK
 
-@param[in] trace_class         Trace class of which to set the default byte
+@param[in] trace_class         Trace class of which to set the native byte
                                order.
-@param[in] native_byte_order   Default byte order of the trace class.
+@param[in] native_byte_order   Native byte order of the trace class.
 @returns                       0 on success, or a negative value on error.
 
 @prenotnull{trace_class}
-@prenotnull{name}
 @prehot{trace_class}
 @pre \p native_byte_order is either #BT_CTF_BYTE_ORDER_LITTLE_ENDIAN,
        #BT_CTF_BYTE_ORDER_BIG_ENDIAN, or
        #BT_CTF_BYTE_ORDER_NETWORK.
 @postrefcountsame{trace_class}
 
-@sa bt_ctf_trace_get_name(): Returns the name of a given trace class.
+@sa bt_ctf_trace_get_native_byte_order(): Returns the native byte order of a
+       given trace class.
 */
 extern int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace_class,
                enum bt_ctf_byte_order native_byte_order);