Implement the .o file generation in lttng-gen-tp

[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..551f003601b892fd77d45838814026eaf7e5d46d 100644 (file)
--- a/doc/man/lttng-gen-tp.1
+++ b/doc/man/lttng-gen-tp.1
@@ -21,10 +21,12 @@ 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.
 
 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.
 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."
 advantages and disadvantage of each form.
 To compile the resulting .c file, you need to add the options
 "-llttng-ust -I."


@@ -45,11 +47,11 @@ Increase verbosity.
 .TP
 .BR "\-o, \-\-output"
 Specify the generated file. The type of the generated file depend on the file
 .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
 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"
 
 
 .SH "TEMPLATE FILE FORMAT"
 


@@ -77,7 +79,19 @@ TRACEPOINT_EVENT(
         ctf_string(message, text)
     )
 )
         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
 .SH "SEE ALSO"
 
 .PP