X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fexamples%2Feasy-ust%2Fsample_component_provider.h;h=16c1ee3c0bbf3b2ddf9264a797556c314b79264d;hb=85b4ad5854c5ca958482cfaec1b3875f7db72a67;hp=dd3c5f0f6fb6106a2d271501e456a377cc365bbd;hpb=9376394f08232d19fff187d1202233d265401f04;p=lttng-ust.git diff --git a/doc/examples/easy-ust/sample_component_provider.h b/doc/examples/easy-ust/sample_component_provider.h index dd3c5f0f..16c1ee3c 100644 --- a/doc/examples/easy-ust/sample_component_provider.h +++ b/doc/examples/easy-ust/sample_component_provider.h @@ -1,6 +1,6 @@ /* * Copyright (C) 2011-2012 Mathieu Desnoyers - * Copyright (C) 2011-2012 Matthew Khouzam + * Copyright (C) 2011-2012 Matthew Khouzam * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -20,9 +20,9 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - + /* - * Sample lttng-ust tracepoint provider. + * Sample lttng-ust tracepoint provider. */ /* @@ -30,8 +30,8 @@ * We undef a macro before defining it as it can be used in several files. */ -/* - * Must be included before include tracepoint provider +/* + * Must be included before include tracepoint provider * ex.: project_event * ex.: project_component_event * @@ -58,69 +58,69 @@ #define _SAMPLE_COMPONENT_PROVIDER_H /* * Add this to allow programs to call "tracepoint(...): - */ -#include + */ +#include /* * The following tracepoint event writes a message (c string) into the * field message of the trace event message in the provider * sample_component in other words: * - * sample_component:message:message = text. + * sample_component:message:message = text. */ TRACEPOINT_EVENT( /* * provider name, not a variable but a string starting with a letter - * and containing either letters, numbers or underscores. + * and containing either letters, numbers or underscores. * Needs to be the same as TRACEPOINT_PROVIDER */ sample_component, /* - * tracepoint name, same format as sample provider. Does not need to be - * declared before. in this case the name is "message" + * tracepoint name, same format as sample provider. Does not need to be + * declared before. in this case the name is "message" */ message, /* - * TP_ARGS macro contains the arguments passed for the tracepoint + * TP_ARGS macro contains the arguments passed for the tracepoint * it is in the following format * 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) + * 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 - */ + */ TP_ARGS(char *, text), /* - * TP_FIELDS describes how to write the fields of the trace event. + * TP_FIELDS describes how to write the fields of the trace event. * You can use the args here */ TP_FIELDS( /* * The ctf_string macro takes a c string and writes it into a field - * named "message" - */ + * named "message" + */ ctf_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. + * 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 line 347 */ TRACEPOINT_LOGLEVEL( /* - * The provider name, must be the same as the provider name in the + * The provider name, must be the same as the provider name in the * TRACEPOINT_EVENT and as TRACEPOINT_PROVIDER above. */ - sample_component, - /* - * The tracepoint name, must be the same as the tracepoint name in the + sample_component, + /* + * The tracepoint name, must be the same as the tracepoint name in the * TRACEPOINT_EVENT */ - message, + message, /* * The tracepoint loglevel. Warning, some levels are abbreviated and * others are not, please see @@ -130,6 +130,6 @@ TRACEPOINT_LOGLEVEL( #endif /* _SAMPLE_COMPONENT_PROVIDER_H */ /* - * Add this after defining the tracepoint events to expand the macros. - */ + * Add this after defining the tracepoint events to expand the macros. + */ #include