Tracepoints: clarify order of TRACEPOINT_EVENT vs TRACEPOINT_LOGLEVEL

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/include/ust/tracepoint.h b/include/ust/tracepoint.h
index b7c38a2475a56c8de014ed7d5f8a4e6151c68850..e7c6b198bc464bde94990623df48912b4af51a68 100644 (file)
--- a/include/ust/tracepoint.h
+++ b/include/ust/tracepoint.h
@@ -392,9 +392,11 @@ static void __attribute__((destructor)) __tracepoints__destroy(void)
  *              TP_LOGLEVEL(LOG_DEBUG,   7)
  *      )
  *
- * 2) Then, declare tracepoint loglevels for tracepoints. The first
- *    field is the name of the tracepoint, the second field is the
- *    loglevel name.
+ * 2) Then, declare tracepoint loglevels for tracepoints. A
+ *    TRACEPOINT_EVENT should be declared prior to the the
+ *    TRACEPOINT_LOGLEVEL for a given tracepoint name. The first field
+ *    is the name of the tracepoint, the second field is the loglevel
+ *    name.
  *
  *      TRACEPOINT_LOGLEVEL(< [com_company_]project_[component_]event >,
  *              < loglevel_name >)