linux-add-lttng-layer: probes/Makefile -> probes/KBuild

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

diff --git a/2.7/lttng-docs-2.7.txt b/2.7/lttng-docs-2.7.txt
index 3210b83645f2306122f46608db8293e2d1324058..f5dce4c3d93103634888e74c4fec362041197ab2 100644 (file)
--- a/2.7/lttng-docs-2.7.txt
+++ b/2.7/lttng-docs-2.7.txt
@@ -7,6 +7,9 @@ v2.7, 25 October 2016
 include::../common/copyright.txt[]
 
 
+include::../common/warning-not-maintained.txt[]
+
+
 include::../common/welcome.txt[]
 
 
@@ -286,6 +289,8 @@ becomes inactive or in real-time.
 [[installing-lttng]]
 == Installation
 
+include::../common/warning-installation-outdated.txt[]
+
 **LTTng** is a set of software <<plumbing,components>> which interact to
 <<instrumenting,instrument>> the Linux kernel and user applications, and
 to <<controlling-tracing,control tracing>> (start and stop
@@ -327,8 +332,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.
@@ -347,7 +355,10 @@ other openSUSE releases.
 
 |Arch Linux
 |_Not available_
-|<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
+|
+LTTng{nbsp}2.8 on the AUR.
+
+<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
 
 |Alpine Linux
 |_Not available_
@@ -382,8 +393,8 @@ other Yocto releases.
 [[ubuntu]]
 === [[ubuntu-official-repositories]]Ubuntu
 
-LTTng{nbsp}{revision} is available on Ubuntu 16.04 _Xenial Xerus_. For
-previous releases of Ubuntu, <<ubuntu-ppa,use the LTTng
+LTTng{nbsp}{revision} is available on Ubuntu{nbsp}16.04 _Xenial Xerus_.
+For previous releases of Ubuntu, <<ubuntu-ppa,use the LTTng
 Stable{nbsp}{revision} PPA>>.
 
 To install LTTng{nbsp}{revision} on Ubuntu{nbsp}16.04 _Xenial Xerus_:
@@ -411,7 +422,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:
 +
 --
@@ -470,7 +481,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:
 +
 --
@@ -2543,7 +2554,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
@@ -2752,10 +2763,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.
@@ -3204,7 +3216,7 @@ include::../common/ust-sit-step-tp-so.txt[]
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
-  following line:
+  following lines:
 +
 --
 [source,c]
@@ -3291,7 +3303,7 @@ include::../common/ust-sit-step-tp-so.txt[]
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
-  following line:
+  following lines:
 +
 --
 [source,c]
@@ -3440,7 +3452,7 @@ include::../common/ust-sit-step-tp-so.txt[]
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
-  following line:
+  following lines:
 +
 --
 [source,c]
@@ -3513,7 +3525,7 @@ include::../common/ust-sit-step-tp-so.txt[]
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
-  following line:
+  following lines:
 +
 --
 [source,c]
@@ -4238,10 +4250,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
@@ -4825,12 +4835,12 @@ MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "."
 ----
 --
 
-. Edit path:{probes/Makefile} and add your new kernel module object
+. Edit path:{probes/KBuild} and add your new kernel module object
   next to the existing ones:
 +
 --
 [source,make]
-.path:{probes/Makefile}
+.path:{probes/KBuild}
 ----
 # ...
 
@@ -5140,7 +5150,7 @@ To output LTTng traces to a non-default location:
 --
 [role="term"]
 ----
-lttng create --output=/tmp/some-directory my-session
+lttng create my-session --output=/tmp/some-directory
 ----
 --
 
@@ -6032,7 +6042,7 @@ To use LTTng live:
 --
 [role="term"]
 ----
-lttng create --live my-session
+lttng create my-session --live
 ----
 --
 +
@@ -6098,7 +6108,7 @@ To take a snapshot:
 --
 [role="term"]
 ----
-lttng create --snapshot my-session
+lttng create my-session --snapshot
 ----
 --
 +
@@ -6198,7 +6208,7 @@ trace data after a system crash:
 --
 [role="term"]
 ----
-lttng create --shm-path=/path/to/shm
+lttng create my-session -shm-path=/path/to/shm
 ----
 --