doc/man: add typical `$` and `#` prompts to command lines

[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 392e5cb7e6751a5bdfcb9ebd4734092747dfe223..4654ca5719dea81efcdcada5f83f7228e0021057 100644 (file)
--- a/doc/man/lttng-ust-dl.3.txt
+++ b/doc/man/lttng-ust-dl.3.txt
@@ -14,7 +14,7 @@ Launch your application by preloading `liblttng-ust-dl.so`:
 
 [role="term"]
 [verse]
-*LD_PRELOAD=liblttng-ust-dl.so* my-app
+$ *LD_PRELOAD=liblttng-ust-dl.so* my-app
 
 
 DESCRIPTION
@@ -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.
@@ -35,12 +45,67 @@ The following LTTng-UST events are available when using this library:
 Fields:
 +
 [options="header"]
-|==============================================================
-| Field name                 | Description
-| `baddr`                    | Base address of loaded library
-| `memsz`                    | Size of loaded library in memory
-| `path`                     | Path to loaded library file
-|==============================================================
+|===
+|Field name |Description
+
+|`baddr`
+|Base address of loaded library.
+
+|`memsz`
+|Size of loaded library in memory.
+
+|`flags`
+|Flags passed to man:dlopen(3).
+
+|`path`
+|Path to loaded library file.
+
+|`has_build_id`
+|Whether or not the loaded library has a build ID. If this field is 1,
+you can expect that an `lttng_ust_dl:build_id` event record
+follows this one (not necessarily immediately after).
+
+|`has_debug_link`
+|Whether or not the loaded library has debug link information. If this
+field is 1, you can expect that an `lttng_ust_dl:debug_link` event
+record follows this one (not necessarily immediately after).
+|===
+
+`lttng_ust_dl:dlmopen`::
+    Emitted when man:dlmopen(3) is called.
++
+Fields:
++
+[options="header"]
+|===
+|Field name |Description
+
+|`baddr`
+|Base address of loaded library.
+
+|`memsz`
+|Size of loaded library in memory.
+
+|`nsid`
+|ID of the namespace in which the library is loaded (as passed
+to man:dlmopen(3)).
+
+|`flags`
+|Flags passed to man:dlmopen(3).
+
+|`path`
+|Path to loaded library file.
+
+|`has_build_id`
+|Whether or not the loaded library has a build ID. If this field is 1,
+you can expect that an `lttng_ust_dl:build_id` event record
+follows this one (not necessarily immediately after).
+
+|`has_debug_link`
+|Whether or not the loaded library has debug link information. If this
+field is 1, you can expect that an `lttng_ust_dl:debug_link` event
+record follows this one (not necessarily immediately after).
+|===
 
 `lttng_ust_dl:dlclose`::
     Emitted when man:dlclose(3) is called.
@@ -48,10 +113,12 @@ Fields:
 Fields:
 +
 [options="header"]
-|==============================================================
-| Field name                 | Description
-| `baddr`                    | Base address of loaded library
-|==============================================================
+|===
+|Field name |Description
+
+|`baddr`
+|Base address of loaded library.
+|===
 
 `lttng_ust_dl:debug_link`::
     Emitted when debug link information is found when loading a library
@@ -62,12 +129,18 @@ Fields:
 Fields:
 +
 [options="header"]
-|==============================================================
-| Field name                 | Description
-| `baddr`                    | Base address of loaded library
-| `filename`                 | Debug link file name
-| `crc`                      | Debug link file's CRC
-|==============================================================
+|===
+|Field name |Description
+
+|`baddr`
+|Base address of loaded library.
+
+|`filename`
+|Debug link file name.
+
+|`crc`
+|Debug link file's CRC.
+|===
 
 `lttng_ust_dl:build_id`::
     Emitted when a build ID is found when loading a library
@@ -78,11 +151,15 @@ Fields:
 Fields:
 +
 [options="header"]
-|==============================================================
-| Field name                 | Description
-| `baddr`                    | Base address of loaded library
-| `build_id`                 | Build ID
-|==============================================================
+|===
+|Field name |Description
+
+|`baddr`
+|Base address of loaded library.
+
+|`build_id`
+|Build ID.
+|===
 
 
 include::common-footer.txt[]