Tracepoint API namespacing ctf_string

[lttng-ust.git] / doc / examples / easy-ust / sample_component_provider.h

diff --git a/doc/examples/easy-ust/sample_component_provider.h b/doc/examples/easy-ust/sample_component_provider.h
index d457664d8aa1fa9c9daf3750a816a7027b003612..39d748e7cb43da1b0b7f2c5383e6fdbf6ffea945 100644 (file)
--- a/doc/examples/easy-ust/sample_component_provider.h
+++ b/doc/examples/easy-ust/sample_component_provider.h
@@ -25,20 +25,20 @@
  * In this example, "sample" is the project, and "component" is the
  * component.
  */
-#undef TRACEPOINT_PROVIDER
-#define TRACEPOINT_PROVIDER sample_component
+#undef LTTNG_UST_TRACEPOINT_PROVIDER
+#define LTTNG_UST_TRACEPOINT_PROVIDER sample_component
 
 /*
  * include file (this files's name)
  */
-#undef TRACEPOINT_INCLUDE
-#define TRACEPOINT_INCLUDE "./sample_component_provider.h"
+#undef LTTNG_UST_TRACEPOINT_INCLUDE
+#define LTTNG_UST_TRACEPOINT_INCLUDE "./sample_component_provider.h"
 
 /*
  * Add this precompiler conditionals to ensure the tracepoint event generation
  * can include this file more than once.
  */
-#if !defined(_SAMPLE_COMPONENT_PROVIDER_H) || defined(TRACEPOINT_HEADER_MULTI_READ)
+#if !defined(_SAMPLE_COMPONENT_PROVIDER_H) || defined(LTTNG_UST_TRACEPOINT_HEADER_MULTI_READ)
 #define _SAMPLE_COMPONENT_PROVIDER_H
 /*
  * Add this to allow programs to call "tracepoint(...):
@@ -52,11 +52,11 @@
  *
  *    sample_component:message:message = text.
  */
-TRACEPOINT_EVENT(
+LTTNG_UST_TRACEPOINT_EVENT(
        /*
         * provider name, not a variable but a string starting with a letter
         * and containing either letters, numbers or underscores.
-        * Needs to be the same as TRACEPOINT_PROVIDER
+        * Needs to be the same as LTTNG_UST_TRACEPOINT_PROVIDER
         */
        sample_component,
        /*
@@ -65,51 +65,53 @@ TRACEPOINT_EVENT(
         */
        message,
        /*
-        * TP_ARGS macro contains the arguments passed for the tracepoint
+        * LTTNG_UST_TP_ARGS macro contains the arguments passed for the tracepoint
         * it is in the following format
-        *              TP_ARGS( type1, name1, type2, name2, ... type10, name10)
+        *              LTTNG_UST_TP_ARGS( type1, name1, type2, name2, ... type10, name10)
         * where there can be from zero to ten elements.
         * typeN is the datatype, such as int, struct or double **.
         * name is the variable name (in "int myInt" the name would be myint)
-        *              TP_ARGS() is valid to mean no arguments
-        *              TP_ARGS( void ) is valid too
+        *              LTTNG_UST_TP_ARGS() is valid to mean no arguments
+        *              LTTNG_UST_TP_ARGS( void ) is valid too
         */
-       TP_ARGS(const char *, text),
+       LTTNG_UST_TP_ARGS(const char *, text),
        /*
-        * TP_FIELDS describes how to write the fields of the trace event.
+        * LTTNG_UST_TP_FIELDS describes how to write the fields of the trace event.
         * You can use the args here
         */
-       TP_FIELDS(
+       LTTNG_UST_TP_FIELDS(
        /*
-        * The ctf_string macro takes a c string and writes it into a field
+        * The lttng_ust_field_string macro takes a c string and writes it into a field
         * named "message"
         */
-               ctf_string(message, text)
+               lttng_ust_field_string(message, text)
        )
 )
 /*
- * Trace loglevel, shows the level of the trace event. It can be TRACE_EMERG,
- * TRACE_ALERT, TRACE_CRIT, TRACE_ERR, TRACE_WARNING, TRACE_INFO or others.
- * If this is not set, TRACE_DEFAULT is assumed.
- * The first two arguments identify the tracepoint
- * See details in <lttng/tracepoint.h> line 347
+ * Trace loglevel, shows the level of the trace event. It can be
+ * LTTNG_UST_TRACEPOINT_LOGLEVEL_EMERG, LTTNG_UST_TRACEPOINT_LOGLEVEL_ALERT,
+ * LTTNG_UST_TRACEPOINT_LOGLEVEL_CRIT, LTTNG_UST_TRACEPOINT_LOGLEVEL_ERR,
+ * LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING, LTTNG_UST_TRACEPOINT_LOGLEVEL_INFO or
+ * others.  If this is not set, LTTNG_UST_TRACEPOINT_LOGLEVEL_DEFAULT is
+ * assumed.  The first two arguments identify the tracepoint See details in
+ * <lttng/tracepoint.h> line 347
  */
-TRACEPOINT_LOGLEVEL(
+LTTNG_UST_TRACEPOINT_LOGLEVEL(
        /*
         * The provider name, must be the same as the provider name in the
-        * TRACEPOINT_EVENT and as TRACEPOINT_PROVIDER above.
+        * LTTNG_UST_TRACEPOINT_EVENT and as LTTNG_UST_TRACEPOINT_PROVIDER above.
         */
        sample_component,
        /*
         * The tracepoint name, must be the same as the tracepoint name in the
-        * TRACEPOINT_EVENT
+        * LTTNG_UST_TRACEPOINT_EVENT
         */
        message,
        /*
         * The tracepoint loglevel. Warning, some levels are abbreviated and
         * others are not, please see <lttng/tracepoint.h>
         */
-       TRACE_WARNING)
+       LTTNG_UST_TRACEPOINT_LOGLEVEL_WARNING)
 
 #endif /* _SAMPLE_COMPONENT_PROVIDER_H */