manpage: Document probe provider compatibility

[lttng-ust.git] / doc / man / lttng-gen-tp.1

diff --git a/doc/man/lttng-gen-tp.1 b/doc/man/lttng-gen-tp.1
index 3c7034cb7367876967d69509e7f2a738837934d9..84c05c9303ce1142716f8dc186413e07dcfed794 100644 (file)
--- a/doc/man/lttng-gen-tp.1
+++ b/doc/man/lttng-gen-tp.1
@@ -1,7 +1,7 @@
 .TH "LTTNG-GEN-TP" "1" "February 16, 2012" "" ""
 
 .SH "NAME"
-lttng-gen-tp \(em LTTng UST 2.0 tracepoint code generator
+lttng-gen-tp \(em LTTng UST 2.x tracepoint code generator
 
 .SH "SYNOPSIS"
 
@@ -21,13 +21,18 @@ The \fBlttng\-gen\-tp\fP tool simplify the generation of the UST tracepoint
 files. It takes a simple template file and generate the necessary code to use the defined tracepoints in your application.
 The section TEMPLATE FILE FORMAT describe the content of the template file.
 
-Currently, the tool can generate the .h and .c associated to your
+Currently, the tool can generate the .h, .c and .o associated to your
 tracepoint. The generated .h can be directly included in your application.
-You need to compile the .c into a .o, .a or .so at your choice and
-link it with your application. Refer to the UST documentation for the
+You can let the tool generate the .o or compile the .c yourself.
+You can compile the .c into a .o, .a or .so at your choice and
+link it with your application.
+Refer to the UST documentation for the
 advantages and disadvantage of each form.
 To compile the resulting .c file, you need to add the options
-"-llttng-ust -I."
+"\-llttng-ust \-I.".
+Note for C++ support: although an application instrumented with
+tracepoints can be compiled with g++, tracepoint probes should be
+compiled with gcc (only tested with gcc so far).
 
 .SH "OPTIONS"
 
@@ -45,15 +50,15 @@ Increase verbosity.
 .TP
 .BR "\-o, \-\-output"
 Specify the generated file. The type of the generated file depend on the file
-extension (.h, .c).
+extension (.h, .c, .o).
 This option can be specfied multiple times to generate different file type.
 
 .PP
-When no output is specified de default files are generated with the same base filename as the template file. The default files are: .h, .c.
+When no output is specified de default files are generated with the same base filename as the template file. The default files are: .h, .c, .o.
 
 .SH "TEMPLATE FILE FORMAT"
 
-The template file, which has the usual extention \fB.tp\fP, contains a list of
+The template file, which has the usual extension \fB.tp\fP, contains a list of
 TRACEPOINT_EVENT definitions and other optional definition entries like
 TRACEPOINT_LOGLEVEL.
 (See lttng-ust(3) for the complete list of available definition.)
@@ -77,7 +82,19 @@ TRACEPOINT_EVENT(
         ctf_string(message, text)
     )
 )
+.SH "ENVIRONMENT VARIABLES"
 
+.PP
+When the tool generate an .o file, it will look for the following environment variables
+.PP
+
+.PP
+.IP "CC"
+Specifer which C compiler to use. If the variable is not specified, the
+tool will try "cc" and "gcc"
+
+.IP "CFLAGS"
+Flags directly passed to the compiler
 .SH "SEE ALSO"
 
 .PP