X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=doc%2Fman%2Flttng-ust.3;h=081f0a73c83d3feae061682b945e8e0dd66cc752;hb=4d3b06fe77725f267b85502dbeb51991296b9389;hp=49b3b5d57aa2a52dddd9ca4cb4d9926c2cc8a0c5;hpb=eba411c6aab3199aa9cbc7c1dd128e6a9acbd2db;p=lttng-ust.git

diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
index 49b3b5d5..081f0a73 100644
--- a/doc/man/lttng-ust.3
+++ b/doc/man/lttng-ust.3
@@ -150,6 +150,79 @@ TRACEPOINT_EVENT(
 )
 .fi
 
+.SH "ASSIGNING LOGLEVEL TO EVENTS"
+
+.nf
+
+Optionally, a loglevel can be assigned to a TRACEPOINT_EVENT using the
+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 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
+declared before declaring a TRACEPOINT_LOGLEVEL.
+
+The loglevels go from 0 to 14. Higher numbers imply the most verbosity
+(higher event throughput expected.
+  
+Loglevels 0 through 6, and loglevel 14, match syslog(3) loglevels
+semantic. Loglevels 7 through 13 offer more fine-grained selection of
+debug information.
+  
+   TRACE_EMERG           0
+   system is unusable
+  
+   TRACE_ALERT           1
+   action must be taken immediately
+  
+   TRACE_CRIT            2
+   critical conditions
+  
+   TRACE_ERR             3
+   error conditions
+  
+   TRACE_WARNING         4
+   warning conditions
+  
+   TRACE_NOTICE          5
+   normal, but significant, condition
+  
+   TRACE_INFO            6
+   informational message
+  
+   TRACE_DEBUG_SYSTEM    7
+   debug information with system-level scope (set of programs)
+  
+   TRACE_DEBUG_PROGRAM   8
+   debug information with program-level scope (set of processes)
+  
+   TRACE_DEBUG_PROCESS   9
+   debug information with process-level scope (set of modules)
+  
+   TRACE_DEBUG_MODULE    10
+   debug information with module (executable/library) scope (set of
+   units)
+  
+   TRACE_DEBUG_UNIT      11
+   debug information with compilation unit scope (set of functions)
+  
+   TRACE_DEBUG_FUNCTION  12
+   debug information with function-level scope
+  
+   TRACE_DEBUG_LINE      13
+   debug information with line-level scope (TRACEPOINT_EVENT default)
+  
+   TRACE_DEBUG           14
+   debug-level message (trace_printf default)
+
+See lttng(1) for information on how to use LTTng-UST loglevels.
+
+.fi
+
 .SH "ADDING TRACEPOINTS TO YOUR CODE"
 
 .nf
@@ -178,13 +251,13 @@ carefully:
        directly or through a static library (.a):
     - Into exactly one object of your application: define
       "TRACEPOINT_DEFINE" and include the tracepoint provider.
-    - Use "-I." for the compilation unit containing the tracepoint
+    - Use "\-I." for the compilation unit containing the tracepoint
       provider include (e.g. tp.c).
-    - Link application with "-ldl".
+    - Link application with "\-ldl".
     - If building the provider directly into the application,
-      link the application with "-llttng-ust".
+      link the application with "\-llttng-ust".
     - If building a static library for the provider, link the static
-      library with "-lllttng-ust".
+      library with "\-lllttng-ust".
     - Include the tracepoint provider header into all C files using
       the provider.
     - Example:
@@ -198,9 +271,9 @@ carefully:
       provider header.
     - Include the tracepoint provider header into all instrumented C
       files that use the provider.
-    - Compile the tracepoint provider with "-I.".
-    - Link the tracepoint provider with "-llttng-ust".
-    - Link application with "-ldl".
+    - Compile the tracepoint provider with "\-I.".
+    - Link the tracepoint provider with "\-llttng-ust".
+    - Link application with "\-ldl".
     - Set a LD_PRELOAD environment to preload the tracepoint provider
       shared object before starting the application when tracing is
       needed.
@@ -211,9 +284,12 @@ carefully:
     way libc lazily resolves Thread-Local Storage (TLS) symbols when a
     library is dlopen'd, linking the tracepoint probe or liblttng-ust
     with dlopen() is discouraged. They should be linked with the
-    application using "-llibname" or loaded with LD_PRELOAD.
+    application using "\-llibname" or loaded with LD_PRELOAD.
   - Enable instrumentation and control tracing with the "lttng" command
     from lttng-tools. See lttng-tools doc/quickstart.txt.
+  - 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).
 
 .fi
 
@@ -229,7 +305,7 @@ specify how long the applications should wait for sessiond
 "registration done" command before proceeding to execute the main
 program. The default is 3000ms (3 seconds). The timeout value is
 specified in milliseconds. The value 0 means "don't wait". The value
--1 means "wait forever". Setting this environment variable to 0 is
+\-1 means "wait forever". Setting this environment variable to 0 is
 recommended for applications with time constraints on the process
 startup time.
 .PP