doc/man: document the lttng_ust_lib events

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

diff --git a/doc/man/lttng-ust-dl.3.txt b/doc/man/lttng-ust-dl.3.txt
index 095eb99dec06621903526bcb874b4f4787f5288f..bc7aa9ebbb640f9ef0662649bad0b5e2a0e5c8f3 100644 (file)
--- a/doc/man/lttng-ust-dl.3.txt
+++ b/doc/man/lttng-ust-dl.3.txt
@@ -27,7 +27,17 @@ man:lttng-ust(3)).
 See man:lttng(1) to learn more about how to control LTTng tracing
 sessions.
 
-The following LTTng-UST events are available when using this library:
+IMPORTANT: This LTTng-UST helper can also emit _shared library
+load/unload_ events (see _Shared library load/unload tracking_ in
+man:lttng-ust(3)). You should :not: use the event records generated by
+this LTTng-UST helper (prefixed with `lttng_ust_dl:`) to track the
+loading and unloading of shared libraries, especially in situations
+where a dynamically loaded library loads its own dependencies. Instead,
+do preload `liblttng-ust-dl.so`, but use the shared library load/unload
+event records, which are more reliable, for your tracking analysis.
+
+The following LTTng-UST events are available when using this library.
+
 
 `lttng_ust_dl:dlopen`::
     Emitted when man:dlopen(3) is called.
@@ -39,13 +49,13 @@ Fields:
 |Field name |Description
 
 |`baddr`
-|Base address of loaded library
+|Base address of loaded library.
 
 |`memsz`
-|Size of loaded library in memory
+|Size of loaded library in memory.
 
 |`path`
-|Path to loaded library file
+|Path to loaded library file.
 |===
 
 `lttng_ust_dl:dlclose`::
@@ -58,7 +68,7 @@ Fields:
 |Field name |Description
 
 |`baddr`
-|Base address of loaded library
+|Base address of loaded library.
 |===
 
 `lttng_ust_dl:debug_link`::
@@ -74,13 +84,13 @@ Fields:
 |Field name |Description
 
 |`baddr`
-|Base address of loaded library
+|Base address of loaded library.
 
 |`filename`
-|Debug link file name
+|Debug link file name.
 
 |`crc`
-|Debug link file's CRC
+|Debug link file's CRC.
 |===
 
 `lttng_ust_dl:build_id`::
@@ -96,10 +106,10 @@ Fields:
 |Field name |Description
 
 |`baddr`
-|Base address of loaded library
+|Base address of loaded library.
 
 |`build_id`
-|Build ID
+|Build ID.
 |===