X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=2.8%2Flttng-docs-2.8.txt;h=33efee6a3a1faa05b4510023e7099d0d91feb8bf;hb=78ca092cce7d4ce41332e7609efa90cd38322cc6;hp=6d6ddc91f6eacabd413c47a3a7c2f6ddcab3278a;hpb=4515af6ef6097035c773786cb47a1498456d4668;p=lttng-docs.git

diff --git a/2.8/lttng-docs-2.8.txt b/2.8/lttng-docs-2.8.txt
index 6d6ddc9..33efee6 100644
--- a/2.8/lttng-docs-2.8.txt
+++ b/2.8/lttng-docs-2.8.txt
@@ -1,7 +1,7 @@
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>
-v2.8, 2 December 2016
+v2.8, 6 December 2016
 
 
 include::../common/copyright.txt[]
@@ -74,6 +74,15 @@ include::../common/acknowledgements.txt[]
 [[whats-new]]
 == What's new in LTTng {revision}?
 
+LTTng{nbsp}{revision} bears the name _Isseki Nicho_. The result of a
+collaboration between http://www.dieuduciel.com/[Dieu du Ciel!] and
+Nagano-based Shiga Kogen,
+https://www.beeradvocate.com/beer/profile/1141/53111/[_**Isseki
+Nicho**_] is a strong Imperial Dark Saison offering a rich roasted malt
+flavor combined with a complex fruity finish typical of Saison yeasts.
+
+New features and changes in LTTng{nbsp}{revision}:
+
 * **Tracing control**:
 ** You can attach <<java-application-context,Java application-specific
    context fields>> to a <<channel,channel>> with the
@@ -862,14 +871,15 @@ This tutorial walks you through the steps to:
 
 The following command lines start with cmd:sudo because you need root
 privileges to trace the Linux kernel. You can avoid using cmd:sudo if
-your Unix user is a member of the <<lttng-sessiond,tracing group>>.
+your Unix user is a member of the <<tracing-group,tracing group>>.
 
-. Create a <<tracing-session,tracing session>>:
+. Create a <<tracing-session,tracing session>> which writes its traces
+  to dir:{/tmp/my-kernel-trace}:
 +
 --
 [role="term"]
 ----
-sudo lttng create my-kernel-session
+sudo lttng create my-kernel-session --output=/tmp/my-kernel-trace
 ----
 --
 
@@ -879,20 +889,23 @@ sudo lttng create my-kernel-session
 [role="term"]
 ----
 lttng list --kernel
+lttng list --kernel --syscall
 ----
 --
 
-. Create an <<event,event rule>> which matches the desired event names,
-  for example `sched_switch` and `sched_process_fork`:
+. Create <<event,event rules>> which match the desired instrumentation
+  point names, for example the `sched_switch` and `sched_process_fork`
+  tracepoints, and the man:open(2) and man:close(2) system calls:
 +
 --
 [role="term"]
 ----
 sudo lttng enable-event --kernel sched_switch,sched_process_fork
+sudo lttng enable-event --kernel --syscall open,close
 ----
 --
 +
-You can also create an event rule which _matches_ all the Linux kernel
+You can also create an event rule which matches _all_ the Linux kernel
 tracepoints (this will generate a lot of data when tracing):
 +
 --
@@ -902,7 +915,7 @@ sudo lttng enable-event --kernel --all
 ----
 --
 
-. Start tracing:
+. <<basic-tracing-session-control,Start tracing>>:
 +
 --
 [role="term"]
@@ -913,7 +926,8 @@ sudo lttng start
 
 . Do some operation on your system for a few seconds. For example,
   load a website, or list the files of a directory.
-. Stop tracing and destroy the tracing session:
+. <<basic-tracing-session-control,Stop tracing>> and destroy the
+  tracing session:
 +
 --
 [role="term"]
@@ -926,10 +940,15 @@ sudo lttng destroy
 The man:lttng-destroy(1) command does not destroy the trace data; it
 only destroys the state of the tracing session.
 
-By default, LTTng saves the traces in
-+$LTTNG_HOME/lttng-traces/__name__-__date__-__time__+,
-where +__name__+ is the tracing session name. Note that the
-env:LTTNG_HOME environment variable defaults to `$HOME` if not set.
+. For the sake of this example, make the recorded trace accessible to
+  the non-root users:
++
+--
+[role="term"]
+----
+sudo chown -R $(whoami) /tmp/my-kernel-trace
+----
+--
 
 See <<viewing-and-analyzing-your-traces,View and analyze the
 recorded events>> to view the recorded events.
@@ -1141,7 +1160,7 @@ lttng enable-event --userspace hello_world:my_first_tracepoint
 ----
 --
 
-. Start tracing:
+. <<basic-tracing-session-control,Start tracing>>:
 +
 --
 [role="term"]
@@ -1152,7 +1171,8 @@ lttng start
 
 . Go back to the running `hello` application and press Enter. The
   program executes all `tracepoint()` instrumentation points and exits.
-. Stop tracing and destroy the tracing session:
+. <<basic-tracing-session-control,Stop tracing>> and destroy the
+  tracing session:
 +
 --
 [role="term"]
@@ -1167,7 +1187,7 @@ only destroys the state of the tracing session.
 
 By default, LTTng saves the traces in
 +$LTTNG_HOME/lttng-traces/__name__-__date__-__time__+,
-where +__name__+ is the tracing session name. Note that the
+where +__name__+ is the tracing session name. The
 env:LTTNG_HOME environment variable defaults to `$HOME` if not set.
 
 See <<viewing-and-analyzing-your-traces,View and analyze the
@@ -1201,7 +1221,7 @@ Many tools are available to read LTTng traces:
 
 NOTE: This section assumes that the traces recorded during the previous
 tutorials were saved to their default location, in the
-dir:{$LTTNG_HOME/lttng-traces} directory. Note that the env:LTTNG_HOME
+dir:{$LTTNG_HOME/lttng-traces} directory. The env:LTTNG_HOME
 environment variable defaults to `$HOME` if not set.
 
 
@@ -1224,7 +1244,7 @@ further filtering:
 
 [role="term"]
 ----
-babeltrace ~/lttng-traces/my-kernel-session* | grep sys_
+babeltrace /tmp/my-kernel-trace | grep _switch
 ----
 
 You can pipe the output of cmd:babeltrace into a tool like man:wc(1) to
@@ -1232,7 +1252,7 @@ count the recorded events:
 
 [role="term"]
 ----
-babeltrace ~/lttng-traces/my-kernel-session* | grep sys_read | wc --lines
+babeltrace /tmp/my-kernel-trace | grep _open | wc --lines
 ----
 
 
@@ -1334,7 +1354,7 @@ Run this script:
 
 [role="term"]
 ----
-python3 top5proc.py ~/lttng-traces/my-kernel-session*/kernel
+python3 top5proc.py /tmp/my-kernel-trace/kernel
 ----
 
 Output example:
@@ -5080,8 +5100,8 @@ Any event that the LTTng logger emits is named `lttng_logger` and
 belongs to the Linux kernel <<domain,tracing domain>>. However, unlike
 other instrumentation points in the kernel tracing domain, **any Unix
 user** can <<enabling-disabling-events,create an event rule>> which
-matches its event name, not only the root user or users in the tracing
-group.
+matches its event name, not only the root user or users in the
+<<tracing-group,tracing group>>.
 
 To use the LTTng logger:
 
@@ -7339,7 +7359,7 @@ tracer::
 <<domain,tracing domain>>::
   A namespace for event sources.
 
-tracing group::
+<<tracing-group,tracing group>>::
   The Unix group in which a Unix user can be to be allowed to trace the
   Linux kernel.