ubuntu: LTTng-UST Python agent only for Python 3

[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..074d33dffaa8c17427defc5227614c3fadec6d9d 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.
@@ -386,8 +387,11 @@ other Ubuntu releases.
 
 |Fedora
 |_Not available_
-|LTTng{nbsp}{revision} for Fedora{nbsp}25 and Fedora{nbsp}26 (not
-released yet).
+|LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision} for
+Fedora{nbsp}25 and Fedora{nbsp}26 (both are not released yet).
+
+<<building-from-source,Build LTTng-modules{nbsp}{revision} from
+source>>.
 
 <<building-from-source,Build LTTng{nbsp}{revision} from source>> for
 other Fedora releases.
@@ -406,7 +410,7 @@ previous Debian releases.
 other openSUSE releases.
 
 |Arch Linux
-|Latest AUR packages.
+|<<arch-linux,Latest AUR packages>>
 |
 
 |Alpine Linux
@@ -444,7 +448,7 @@ LTTng{nbsp}{revision} is available on Ubuntu{nbsp}16.10 _Yakkety Yak_.
 For previous releases of Ubuntu, <<ubuntu-ppa,use the LTTng
 Stable{nbsp}{revision} PPA>>.
 
-To install LTTng{nbsp}{revision} on Ubuntu 16.10{nbsp}_Yakkety Yak_:
+To install LTTng{nbsp}{revision} on Ubuntu{nbsp}16.10 _Yakkety Yak_:
 
 . Install the main LTTng{nbsp}{revision} packages:
 +
@@ -469,7 +473,7 @@ sudo apt-get install liblttng-ust-agent-java
 --
 
 . **If you need to instrument and trace
-  <<python-application,Python applications>>**, install the
+  <<python-application,Python{nbsp}3 applications>>**, install the
   LTTng-UST Python agent:
 +
 --
@@ -526,7 +530,7 @@ sudo apt-get install liblttng-ust-agent-java
 --
 
 . **If you need to instrument and trace
-  <<python-application,Python applications>>**, install the
+  <<python-application,Python{nbsp}3 applications>>**, install the
   LTTng-UST Python agent:
 +
 --
@@ -574,11 +578,40 @@ sudo apt-get install python3-lttngust
 --
 
 
+[[arch-linux]]
+=== Arch Linux
+
+To install LTTng{nbsp}{revision} on Arch Linux using
+https://archlinux.fr/yaourt-en[Yaourt]:
+
+. Install the main LTTng{nbsp}{revision} packages:
++
+--
+[role="term"]
+----
+yaourt -S lttng-tools
+yaourt -S lttng-ust
+yaourt -S lttng-modules
+----
+--
+
+. **If you need to instrument and trace <<python-application,Python
+  applications>>**, install the LTTng-UST Python agent:
++
+--
+[role="term"]
+----
+yaourt -S python-lttngust
+yaourt -S python2-lttngust
+----
+--
+
+
 [[alpine-linux]]
 === Alpine Linux
 
-To install LTTng{nbsp}{revision} (tracing control and user space
-tracing) on Alpine Linux "edge":
+To install LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision} on
+Alpine Linux "edge":
 
 . Make sure your system is
   https://wiki.alpinelinux.org/wiki/Edge[configured for "edge"].
@@ -2627,7 +2660,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 +2869,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 +4334,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