2.11: update installation

[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 1839ea16dc0e37224e828670c95072d41a4c983c..53198fa4ae8ec237705c4a8e9b35326ff27ff9e8 100644 (file)
--- a/2.7/lttng-docs-2.7.txt
+++ b/2.7/lttng-docs-2.7.txt
@@ -1,12 +1,15 @@
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>

-v2.7, 25 October 2016
+v2.7, 24 July 2017

 
 
 include::../common/copyright.txt[]
 
 
 
 
 include::../common/copyright.txt[]
 
 

+include::../common/warning-not-maintained.txt[]
+
+

 include::../common/welcome.txt[]
 
 
 include::../common/welcome.txt[]
 
 


@@ -286,6 +289,8 @@ becomes inactive or in real-time.
 [[installing-lttng]]
 == Installation
 
 [[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
 **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


@@ -417,7 +422,7 @@ sudo apt-get install liblttng-ust-agent-java
 --
 
 . **If you need to instrument and trace
 --
 
 . **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:
 +
 --
   LTTng-UST Python agent:
 +
 --


@@ -476,7 +481,7 @@ sudo apt-get install liblttng-ust-agent-java
 --
 
 . **If you need to instrument and trace
 --
 
 . **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:
 +
 --
   LTTng-UST Python agent:
 +
 --


@@ -1623,7 +1628,7 @@ With so many similar terms, it's easy to get confused.
 An **event** is the consequence of the execution of an _instrumentation
 point_, like a tracepoint that you manually place in some source code,
 or a Linux kernel KProbe. An event is said to _occur_ at a specific
 An **event** is the consequence of the execution of an _instrumentation
 point_, like a tracepoint that you manually place in some source code,
 or a Linux kernel KProbe. An event is said to _occur_ at a specific

-time. Different actions can be taken upon the occurance of an event,
+time. Different actions can be taken upon the occurrence of an event,

 like record the event's payload to a buffer.
 
 An **event record** is the representation of an event in a sub-buffer. A
 like record the event's payload to a buffer.
 
 An **event record** is the representation of an event in a sub-buffer. A


@@ -1658,7 +1663,7 @@ The LTTng project incorporates:
 * **LTTng-tools**: Libraries and command-line interface to
   control tracing sessions.
 ** <<lttng-sessiond,Session daemon>> (man:lttng-sessiond(8)).
 * **LTTng-tools**: Libraries and command-line interface to
   control tracing sessions.
 ** <<lttng-sessiond,Session daemon>> (man:lttng-sessiond(8)).

-** <<lttng-consumerd,Consumer daemon>> (man:lttng-consumerd(8)).
+** <<lttng-consumerd,Consumer daemon>> (cmd:lttng-consumerd).

 ** <<lttng-relayd,Relay daemon>> (man:lttng-relayd(8)).
 ** <<liblttng-ctl-lttng,Tracing control library>> (`liblttng-ctl`).
 ** <<lttng-cli,Tracing control command-line tool>> (man:lttng(1)).
 ** <<lttng-relayd,Relay daemon>> (man:lttng-relayd(8)).
 ** <<liblttng-ctl-lttng,Tracing control library>> (`liblttng-ctl`).
 ** <<lttng-cli,Tracing control command-line tool>> (man:lttng(1)).


@@ -1954,7 +1959,7 @@ running. You can also start the session daemon manually.
 .The consumer daemon.
 image::plumbing-consumerd.png[]
 
 .The consumer daemon.
 image::plumbing-consumerd.png[]
 

-The _consumer daemon_, man:lttng-consumerd(8), is a daemon which shares
+The _consumer daemon_, cmd:lttng-consumerd, is a daemon which shares

 ring buffers with user applications or with the LTTng kernel modules to
 collect trace data and send it to some location (on disk or to a
 <<lttng-relayd,relay daemon>> over the network). The consumer daemon
 ring buffers with user applications or with the LTTng kernel modules to
 collect trace data and send it to some location (on disk or to a
 <<lttng-relayd,relay daemon>> over the network). The consumer daemon


@@ -3211,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
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the

-  following line:
+  following lines:

 +
 --
 [source,c]
 +
 --
 [source,c]


@@ -3298,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
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the

-  following line:
+  following lines:

 +
 --
 [source,c]
 +
 --
 [source,c]


@@ -3447,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
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the

-  following line:
+  following lines:

 +
 --
 [source,c]
 +
 --
 [source,c]


@@ -3520,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
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the

-  following line:
+  following lines:

 +
 --
 [source,c]
 +
 --
 [source,c]


@@ -4830,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]
   next to the existing ones:
 +
 --
 [source,make]

-.path:{probes/Makefile}
+.path:{probes/KBuild}

 ----
 # ...
 
 ----
 # ...
 


@@ -5145,7 +5150,7 @@ To output LTTng traces to a non-default location:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----

-lttng create --output=/tmp/some-directory my-session
+lttng create my-session --output=/tmp/some-directory

 ----
 --
 
 ----
 --
 


@@ -6037,7 +6042,7 @@ To use LTTng live:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----

-lttng create --live my-session
+lttng create my-session --live

 ----
 --
 +
 ----
 --
 +


@@ -6103,7 +6108,7 @@ To take a snapshot:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----

-lttng create --snapshot my-session
+lttng create my-session --snapshot

 ----
 --
 +
 ----
 --
 +


@@ -6203,7 +6208,7 @@ trace data after a system crash:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----

-lttng create --shm-path=/path/to/shm
+lttng create my-session -shm-path=/path/to/shm

 ----
 --
 
 ----
 --
 


@@ -6850,7 +6855,7 @@ event::
   or a Linux kernel KProbe.
 +
 An event is said to _occur_ at a specific time. Different actions can
   or a Linux kernel KProbe.
 +
 An event is said to _occur_ at a specific time. Different actions can

-be taken upon the occurance of an event, like record the event's payload
+be taken upon the occurrence of an event, like record the event's payload

 to a sub-buffer.
 
 <<channel-overwrite-mode-vs-discard-mode,event loss mode>>::
 to a sub-buffer.
 
 <<channel-overwrite-mode-vs-discard-mode,event loss mode>>::