doc/man: Document LTTNG_UST_ABORT_ON_CRITICAL variable

[lttng-ust.git] / doc / man / lttng-ust.3.txt

diff --git a/doc/man/lttng-ust.3.txt b/doc/man/lttng-ust.3.txt
index 55b2b20dedba75e6895d9fe4147f7e579b34d90f..0924a4de2dc7d65c411951293598ab0baafd22e6 100644 (file)
--- a/doc/man/lttng-ust.3.txt
+++ b/doc/man/lttng-ust.3.txt
@@ -81,7 +81,11 @@ SYNOPSIS
 #define *lttng_ust_tracepoint*('prov_name', 't_name', ...)
 #define *lttng_ust_tracepoint_enabled*('prov_name', 't_name')
 
 #define *lttng_ust_tracepoint*('prov_name', 't_name', ...)
 #define *lttng_ust_tracepoint_enabled*('prov_name', 't_name')
 

-Link with `-llttng-ust -llttng-ust-common -ldl`, following this man page.
+Link with, following this manual page:
+
+* `-llttng-ust -ldl`
+* If you define `_LGPL_SOURCE` before including
+  `<lttng/tracepoint.h>` (directly or indirectly): `-llttng-ust-common`

 
 
 DESCRIPTION
 
 
 DESCRIPTION


@@ -728,12 +732,12 @@ change, but need not to be otherwise recompiled (unless the tracepoint
 provider's API changes).
 
 Then, link your application with this object file (or with the static
 provider's API changes).
 
 Then, link your application with this object file (or with the static

-library containing it) and with `liblttng-ust`, `liblttng-ust-common`,
-and `libdl` (`libc` on a BSD system):
+library containing it) and with `liblttng-ust` and `libdl` (`libc` on a
+BSD system):

 
 [role="term"]
 ----
 
 [role="term"]
 ----

-$ cc -o app tp.o app.o -llttng-ust -llttng-ust-common -ldl
+$ cc -o app tp.o app.o -llttng-ust -ldl

 ----
 
 
 ----
 
 


@@ -783,8 +787,7 @@ It is then linked as a shared library like this:
 
 [role="term"]
 ----
 
 [role="term"]
 ----

-$ cc -shared -Wl,--no-as-needed -o tp.so tp.o -llttng-ust \
-     -llttng-ust-common
+$ cc -shared -Wl,--no-as-needed -o tp.so tp.o -llttng-ust

 ----
 
 This tracepoint provider shared object isn't linked with the user
 ----
 
 This tracepoint provider shared object isn't linked with the user


@@ -1218,7 +1221,7 @@ like this:
 ----
 $ cc -c -I. tp.c
 $ cc -c app.c
 ----
 $ cc -c -I. tp.c
 $ cc -c app.c

-$ cc -o app tp.o app.o -llttng-ust -llttng-ust-common -ldl
+$ cc -o app tp.o app.o -llttng-ust -ldl

 ----
 
 Using the man:lttng(1) tool, create an LTTng tracing session, enable
 ----
 
 Using the man:lttng(1) tool, create an LTTng tracing session, enable


@@ -1504,6 +1507,9 @@ prevent discarding event records.
 WARNING: Setting this environment variable may significantly
 affect application timings.
 
 WARNING: Setting this environment variable may significantly
 affect application timings.
 

+`LTTNG_UST_ABORT_ON_CRITICAL`::
+    If set, abort the instrumented application on a critical error message.
+

 `LTTNG_UST_CLOCK_PLUGIN`::
     Path to the shared object which acts as the clock override plugin.
     An example of such a plugin can be found in the LTTng-UST
 `LTTNG_UST_CLOCK_PLUGIN`::
     Path to the shared object which acts as the clock override plugin.
     An example of such a plugin can be found in the LTTng-UST