X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-ust.3;h=26841d02e3f89ebf6ba9acdeac0b74867360c30f;hb=bdc3e272df8bbbfdf8607de7a6db4de82d8db66a;hp=aa52c590380aaff5901f5eef8f6769513d1f23c1;hpb=a106a9f8513054954003122126a8b33b56de4bd8;p=lttng-ust.git diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3 index aa52c590..26841d02 100644 --- a/doc/man/lttng-ust.3 +++ b/doc/man/lttng-ust.3 @@ -12,7 +12,7 @@ Link liblttng-ust.so with applications, following this manpage. .SH "DESCRIPTION" .PP -LTTng-UST, the Linux Trace Toolkit Next Generation Userspace Tracer, is +LTTng-UST, the Linux Trace Toolkit Next Generation Userspace Tracer, is a port of the low-overhead tracing capabilities of the LTTng kernel tracer to user-space. The library "liblttng-ust" enables tracing of applications and libraries. @@ -156,6 +156,11 @@ TRACEPOINT_EVENT( ctf_float(double, doublefield, doublearg) ) ) + +There can be an arbitrary number of tracepoint providers within an +application, but they must each have their own provider name. Duplicate +provider names are not allowed. + .fi .SH "ASSIGNING LOGLEVEL TO EVENTS" @@ -168,7 +173,7 @@ following construct: TRACEPOINT_LOGLEVEL(< [com_company_]project[_component] >, < event >, < loglevel_name >) - The first field is the provider name, the second field is the name of +The first field is the provider name, the second field is the name of the tracepoint, and the third field is the loglevel name. A TRACEPOINT_EVENT should be declared prior to the the TRACEPOINT_LOGLEVEL for a given tracepoint name. The TRACEPOINT_PROVIDER must be already @@ -249,7 +254,7 @@ lttng(1) through lttng-sessiond(8). Even though LTTng-UST supports tracepoint() call site duplicates having the same provider and event name, it is recommended to use a provider event name pair only once within the source code to help -mapping events back to their call sites when analyzing the trace. +map events back to their call sites when analyzing the trace. .fi .SH "BUILDING/LINKING THE TRACEPOINT PROVIDER" @@ -378,7 +383,7 @@ lttng-sessiond(8) .PP Older lttng-ust libraries reject more recent, and incompatible, probe -providers. Newer lttng-ust librairies accept older probe providers, even +providers. Newer lttng-ust libraries accept older probe providers, even though some newer features might not be available with those providers. .PP