Fix: man: you can't link a lib with a static lib

[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..cbaf3c779fca4eac2da0317f4b77a3a776b5d5dd 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"
 .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"
 
 
 .SH "SYNOPSIS"
 


@@ -13,26 +13,28 @@ lttng\-gen\-tp [OPTIONS] TEMPLATE_FILE
 
 .PP
 The LTTng project aims at providing highly efficient tracing tools for Linux.
 
 .PP
 The LTTng project aims at providing highly efficient tracing tools for Linux.

-It's tracers help tracking down performance issues and debugging problems
+Its tracers help in tracking down performance issues and debugging problems

 involving multiple concurrent processes and threads. Tracing across multiple
 systems is also possible.
 
 involving multiple concurrent processes and threads. Tracing across multiple
 systems is also possible.
 

-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.
+The \fBlttng\-gen\-tp\fP tool simplifies the generation of the UST tracepoint
+files. It takes a simple template file and generates the necessary code to use the defined tracepoints in your application.
+The section TEMPLATE FILE FORMAT describes 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 with 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
 advantages and disadvantage of each form.
 To compile the resulting .c file, you need to add the options

-"-llttng-ust -I."
+"\-llttng-ust \-I.".

 
 .SH "OPTIONS"
 
 .PP
 
 .SH "OPTIONS"
 
 .PP

-This program follow the usual GNU command line syntax with long options starting with
+This program follows the usual GNU command line syntax with long options starting with

 two dashes. Below is a summary of the available options.
 .PP
 
 two dashes. Below is a summary of the available options.
 .PP
 


@@ -45,15 +47,15 @@ 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).
-This option can be specfied multiple times to generate different file type.
+extension (.h, .c, .o).
+This option can be specified multiple times to generate different file type.

 
 .PP
 
 .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 the 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"
 

-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.)
 TRACEPOINT_EVENT definitions and other optional definition entries like
 TRACEPOINT_LOGLEVEL.
 (See lttng-ust(3) for the complete list of available definition.)


@@ -77,7 +79,19 @@ TRACEPOINT_EVENT(
         ctf_string(message, text)
     )
 )
         ctf_string(message, text)
     )
 )

+.SH "ENVIRONMENT VARIABLES"

 
 

+.PP
+When the tool generates a .o file, it will look for the following environment variables
+.PP
+
+.PP
+.IP "CC"
+Specify 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