CTF IR -> Trace IR

[babeltrace.git] / include / babeltrace / lib-logging-internal.h

diff --git a/include/babeltrace/lib-logging-internal.h b/include/babeltrace/lib-logging-internal.h
index 4373312787e89298b37a1daac096f6b89d4111cf..6e04f9a25a91af218a656c8530aa8b391c7e5ef4 100644 (file)
--- a/include/babeltrace/lib-logging-internal.h
+++ b/include/babeltrace/lib-logging-internal.h
@@ -26,6 +26,10 @@
 #include <babeltrace/babeltrace-internal.h>
 #include <stdarg.h>
 
+#ifndef BT_LOG_TAG
+# error Please define a tag with BT_LOG_TAG before including this file.
+#endif
+
 #define BT_LOG_OUTPUT_LEVEL bt_lib_log_level
 
 #include <babeltrace/logging-internal.h>
@@ -58,7 +62,7 @@ int bt_lib_log_level;
  *   `PRIi64`.
  *
  * The Babeltrace extension conversion specifier is accepted. Its syntax
- * is:
+ * is either `%!u` to format a UUID (`bt_uuid` type) or:
  *
  * 1. Introductory `%!` sequence.
  *
@@ -74,36 +78,35 @@ int bt_lib_log_level;
  *
  * The available format specifiers are:
  *
- *   `r`:
- *       Reference count information. The parameter is any Babeltrace
- *       object.
- *
  *   `F`:
- *       CTF IR field type. The parameter type is `struct bt_field_type *`.
+ *       Trace IR field type. The parameter type is `struct
+ *       bt_field_type *`.
  *
  *   `f`:
- *       CTF IR field. The parameter type is `struct bt_field *`.
+ *       Trace IR field. The parameter type is `struct bt_field *`.
  *
  *   `P`:
  *       Field path. The parameter type is `struct bt_field_path *`.
  *
  *   `E`:
- *       CTF IR event class. The parameter type is `struct bt_event_class *`.
+ *       Trace IR event class. The parameter type is `struct
+ *       bt_event_class *`.
  *
  *   `e`:
- *       CTF IR event. The parameter type is `struct bt_event *`.
+ *       Trace IR event. The parameter type is `struct bt_event *`.
  *
  *   `S`:
- *       CTF IR stream class. The parameter type is `struct bt_stream_class *`.
+ *       Trace IR stream class. The parameter type is `struct
+ *       bt_stream_class *`.
  *
  *   `s`:
- *       CTF IR stream. The parameter type is `struct bt_stream *`.
+ *       Trace IR stream. The parameter type is `struct bt_stream *`.
  *
  *   `a`:
  *       Packet. The parameter type is `struct bt_packet *`.
  *
  *   `t`:
- *       CTF IR trace. The parameter type is `struct bt_trace *`.
+ *       Trace IR trace. The parameter type is `struct bt_trace *`.
  *
  *   `K`:
  *       Clock class. The parameter type is `struct bt_clock_class *`.
@@ -122,7 +125,8 @@ int bt_lib_log_level;
  *       `struct bt_notification_iterator *`.
  *
  *   `C`:
- *       Component class. The parameter type is `struct bt_component_class *`.
+ *       Component class. The parameter type is `struct
+ *       bt_component_class *`.
  *
  *   `c`:
  *       Component. The parameter type is `struct bt_component *`.
@@ -136,12 +140,15 @@ int bt_lib_log_level;
  *   `g`:
  *       Graph. The parameter type is `struct bt_graph *`.
  *
- *   `u`:
+ *   `l`:
  *       Plugin. The parameter type is `struct bt_plugin *`.
  *
  *   `o`:
  *       Object pool. The parameter type is `struct bt_object_pool *`.
  *
+ *   `O`:
+ *       Object. The parameter type is `struct bt_object *`.
+ *
  * Conversion specifier examples:
  *
  *     %!f
@@ -153,7 +160,7 @@ int bt_lib_log_level;
  * the last one. Therefore you must put this separator in the format
  * string between two Babeltrace objects, e.g.:
  *
- *     BT_LIB_LOGW("Message: count=%u, %!E, %!+C", count, event_class,
+ *     BT_LIB_LOGW("Message: count=%u, %!E, %!+K", count, event_class,
  *                 clock_class);
  *
  * Example with a custom prefix: