X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=2.7%2Flttng-docs-2.7.txt;h=53198fa4ae8ec237705c4a8e9b35326ff27ff9e8;hb=013242649af64374247a9314f8a65376de4e2cd0;hp=3b575d4f540e368c4cbe70ec394b61e829ef6048;hpb=974979f01d6e3ffdc7ea313b42152701d47e0bab;p=lttng-docs.git diff --git a/2.7/lttng-docs-2.7.txt b/2.7/lttng-docs-2.7.txt index 3b575d4..53198fa 100644 --- 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 -v2.7, 25 October 2016 +v2.7, 24 July 2017 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 <> which interact to <> the Linux kernel and user applications, and to <> (start and stop @@ -350,7 +355,10 @@ other openSUSE releases. |Arch Linux |_Not available_ -|<>. +| +LTTng{nbsp}2.8 on the AUR. + +<>. |Alpine Linux |_Not available_ @@ -414,7 +422,7 @@ sudo apt-get install liblttng-ust-agent-java -- . **If you need to instrument and trace - <>**, install the + <>**, install the LTTng-UST Python agent: + -- @@ -473,7 +481,7 @@ sudo apt-get install liblttng-ust-agent-java -- . **If you need to instrument and trace - <>**, install the + <>**, install the LTTng-UST Python agent: + -- @@ -1620,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 -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 @@ -1655,7 +1663,7 @@ The LTTng project incorporates: * **LTTng-tools**: Libraries and command-line interface to control tracing sessions. ** <> (man:lttng-sessiond(8)). -** <> (man:lttng-consumerd(8)). +** <> (cmd:lttng-consumerd). ** <> (man:lttng-relayd(8)). ** <> (`liblttng-ctl`). ** <> (man:lttng(1)). @@ -1951,7 +1959,7 @@ running. You can also start the session daemon manually. .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 <> over the network). The consumer daemon @@ -3208,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] @@ -3295,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] @@ -3444,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] @@ -3517,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] @@ -4827,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} ---- # ... @@ -5142,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 ---- -- @@ -6034,7 +6042,7 @@ To use LTTng live: -- [role="term"] ---- -lttng create --live my-session +lttng create my-session --live ---- -- + @@ -6100,7 +6108,7 @@ To take a snapshot: -- [role="term"] ---- -lttng create --snapshot my-session +lttng create my-session --snapshot ---- -- + @@ -6200,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 ---- -- @@ -6847,7 +6855,7 @@ event:: 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. <>::