X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Flib-logging-internal.h;h=ae7fb9e6b31c171079e12414f76705e235269504;hb=7e69c04f557e46fb50e5a888a3bc3451afbd3b8e;hp=e2483b29d9a472980c748526d43360dafcafa974;hpb=44c440bc5fe8219cc17d1b786d91fd83c4c9860a;p=babeltrace.git

diff --git a/include/babeltrace/lib-logging-internal.h b/include/babeltrace/lib-logging-internal.h
index e2483b29..ae7fb9e6 100644
--- a/include/babeltrace/lib-logging-internal.h
+++ b/include/babeltrace/lib-logging-internal.h
@@ -2,7 +2,7 @@
 #define BABELTRACE_LIB_LOGGING_INTERNAL_H
 
 /*
- * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -79,50 +79,57 @@ int bt_lib_log_level;
  * The available format specifiers are:
  *
  *   `F`:
- *       CTF IR field type. The parameter type is `struct bt_field_type *`.
+ *       Trace IR field class. The parameter type is
+ *	 `struct bt_field_class *`.
  *
  *   `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`:
+ *       Trace IR trace class. The parameter type is `struct bt_trace_class *`.
+ *
  *   `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 *`.
  *
  *   `k`:
- *       Clock value. The parameter type is `struct bt_clock_value *`.
+ *       Clock snapshot. The parameter type is `struct bt_clock_snapshot *`.
  *
  *   `v`:
  *       Value. The parameter type is `struct bt_value *`.
  *
  *   `n`:
- *       Notification. The parameter type is `struct bt_notification *`.
+ *       Message. The parameter type is `struct bt_message *`.
  *
  *   `i`:
- *       Notification iterator. The parameter type is
- *       `struct bt_notification_iterator *`.
+ *       Message iterator. The parameter type is
+ *       `struct bt_message_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 *`.
@@ -137,7 +144,7 @@ int bt_lib_log_level;
  *       Graph. The parameter type is `struct bt_graph *`.
  *
  *   `l`:
- *       Plugin. The parameter type is `struct bt_plugin *`.
+ *       Plugin. The parameter type is `const struct bt_plugin *`.
  *
  *   `o`:
  *       Object pool. The parameter type is `struct bt_object_pool *`.
@@ -154,7 +161,7 @@ int bt_lib_log_level;
  *
  * The string `, ` is printed between individual fields, but not after
  * the last one. Therefore you must put this separator in the format
- * string between two Babeltrace objects, e.g.:
+ * string between two conversion specifiers, e.g.:
  *
  *     BT_LIB_LOGW("Message: count=%u, %!E, %!+K", count, event_class,
  *                 clock_class);
@@ -179,7 +186,7 @@ int bt_lib_log_level;
  * Use one of the BT_LIB_LOGF*() macros above instead of calling this
  * function directly.
  */
-BT_HIDDEN
+
 void bt_lib_log(const char *func, const char *file, unsigned line,
 		int lvl, const char *tag, const char *fmt, ...);