X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-gen-tp.1.txt;h=41284c7e4c2c247a4bd34de950effb12fd9795ce;hb=53f7d0d7404de911dd62dff06f08539e33ea7519;hp=494679210c80262976f7e80211a168281f3bb6dd;hpb=4ddbd0b790be981d023f344a83e67a8746fa3688;p=lttng-ust.git diff --git a/doc/man/lttng-gen-tp.1.txt b/doc/man/lttng-gen-tp.1.txt index 49467921..41284c7e 100644 --- a/doc/man/lttng-gen-tp.1.txt +++ b/doc/man/lttng-gen-tp.1.txt @@ -1,3 +1,6 @@ +// SPDX-FileCopyrightText: 2016 Philippe Proulx +// SPDX-License-Identifier: CC-BY-4.0 +// lttng-gen-tp(1) =============== :object-type: program @@ -40,21 +43,22 @@ needed. Template file format ~~~~~~~~~~~~~~~~~~~~ The template file, which usually has the `.tp` extension, contains a -list of `TRACEPOINT_EVENT()` definitions and other optional definition -entries, like `TRACEPOINT_LOGLEVEL()`. See man:lttng-ust(3) for -the complete list of available definitions. +list of `LTTNG_UST_TRACEPOINT_EVENT()` definitions and other optional +definition entries, like `LTTNG_UST_TRACEPOINT_LOGLEVEL()`. See +man:lttng-ust(3) for the complete list of available definitions. -The `TRACEPOINT_EVENT()` definitions are written as you would write them -in an LTTng-UST template provider header file. C comments are supported -(`/* */` and `//`), as well as lines starting with `#`. +The `LTTNG_UST_TRACEPOINT_EVENT()` definitions are written as you would +write them in an LTTng-UST template provider header file. C comments are +supported (`/* */` and `//`), as well as lines starting with `#`. -NOTE: The provider name (the first argument of `TRACEPOINT_EVENT()`) -must be the same in all the `TRACEPOINT_EVENT()` macros of 'TEMPLATE'. +NOTE: The provider name (the first argument of +`LTTNG_UST_TRACEPOINT_EVENT()`) must be the same in all the +`LTTNG_UST_TRACEPOINT_EVENT()` macros of 'TEMPLATE'. Here's an example: --------------------------------------- -TRACEPOINT_EVENT( +LTTNG_UST_TRACEPOINT_EVENT( // Tracepoint provider name my_provider, @@ -62,11 +66,11 @@ TRACEPOINT_EVENT( my_event, // Tracepoint arguments (input) - TP_ARGS(char *, text), + LTTNG_UST_TP_ARGS(char *, text), // Tracepoint/event fields (output) - TP_FIELDS( - ctf_string(message, text) + LTTNG_UST_TP_FIELDS( + lttng_ust_field_string(message, text) ) ) --------------------------------------- @@ -118,7 +122,7 @@ COPYRIGHTS `lttng-gen-tp` is distributed under the http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html[GNU General Public License, version 2]. See the -https://github.com/lttng/lttng-ust/blob/master/COPYING[`COPYING`] file +https://github.com/lttng/lttng-ust/blob/v{lttng_version}/COPYING[`COPYING`] file for more details.