addr2line: link to man page

[lttng-docs.git] / 2.8 / lttng-docs-2.8.txt

diff --git a/2.8/lttng-docs-2.8.txt b/2.8/lttng-docs-2.8.txt
index 89235489ddd38f7faec0bb739a2ee42b8c49d561..ed0c9c6dd7cd2bf433ec9b84b5c535eba16a13c1 100644 (file)
--- a/2.8/lttng-docs-2.8.txt
+++ b/2.8/lttng-docs-2.8.txt
@@ -112,9 +112,10 @@ lttng enable-event --log4j my_logger \
 +
 See man:lttng-status(1).
 
-** New `lttng metadata regenerate` command to regenerate the metadata
-   file of an LTTng trace at any moment. This command is meant to be
-   used to resample the wall time following a major
+** New `lttng metadata regenerate` command to
+   <<metadata-regenerate,regenerate the metadata file of an LTTng
+   trace>> at any moment. This command is meant to be used to resample
+   the wall time following a major
    https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP] correction
    so that a system which boots with an incorrect wall time can be
    traced before its wall time is NTP-corrected.
@@ -2627,7 +2628,7 @@ holding more than one tracepoint providers.
 Once you <<tpp-header,create a tracepoint provider header file>>, you
 can use the `tracepoint()` macro in your application's
 source code to insert the tracepoints that this header
-<<defining-tracepoints,defined>> defines.
+<<defining-tracepoints,defines>>.
 
 The `tracepoint()` macro takes at least two parameters: the tracepoint
 provider name and the tracepoint name. The corresponding tracepoint
@@ -2836,10 +2837,11 @@ In the following diagrams, we use the following file names:
 `libemon.so`::
   User library shared object file.
 
-The red star indicates that this object file is instrumented
-(contains code which uses the `tracepoint()` macro). The spring
-symbol between the application and a library means the application is
-linked with the library at build time.
+We use the following symbols in the diagrams of table below:
+
+[role="img-100"]
+.Symbols used in the build scenario diagrams.
+image::ust-sit-symbols.png[]
 
 We assume that path:{.} is part of the env:LD_LIBRARY_PATH environment
 variable in the following instructions.
@@ -4300,10 +4302,8 @@ Assuming no event record is lost, having only the function addresses on
 entry is enough to create a call graph, since an event record always
 contains the ID of the CPU that generated it.
 +
-You can use a tool like
-https://sourceware.org/binutils/docs/binutils/addr2line.html[cmd:addr2line]
-to convert function addresses back to source file names and
-line numbers.
+You can use a tool like man:addr2line(1) to convert function addresses
+back to source file names and line numbers.
 
 * **path:{liblttng-ust-cyg-profile.so}** is a more robust variant
 which also works in use cases where event records might get discarded or