doc: Mention that all LTTng-Analyses are now supported
authorAlexandre Montplaisir <alexmonthy@efficios.com>
Wed, 31 Aug 2016 22:16:24 +0000 (18:16 -0400)
committerAlexandre Montplaisir <alexmonthy@efficios.com>
Thu, 1 Sep 2016 18:17:48 +0000 (14:17 -0400)
Trace Compass should now support the current latest
LTTng-Analyses scripts, so no need for users to remain
on the 0.4 branch.

While at it renamed the section titles to use present
progressive (Running, etc.) to match the rest of the
documentation.

Change-Id: Id99e77cfff8fa1461de63c33fb3a5003d43275f4
Signed-off-by: Alexandre Montplaisir <alexmonthy@efficios.com>
Reviewed-on: https://git.eclipse.org/r/80179
Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-by: Hudson CI
doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki

index dd8dc3f3b230551c68ba1af744509a968b7047db..6b0176dae13440d28832649e135c4620e19084f0 100644 (file)
@@ -855,15 +855,15 @@ To modify the time of attributes shown in the view, select a different current t
 
 == External Analyses ==
 
-Trace Compass supports the execution of '''external analyses''' conforming to the machine interface of [https://github.com/lttng/lttng-analyses/releases/tag/v0.4.3 LTTng-Analyses 0.4.3], or any later [https://github.com/lttng/lttng-analyses/releases LTTng-Analyses 0.4.x] version. Later (0.5+) versions of LTTng-Analyses will be supported by later versions of Trace Compass.
+Trace Compass supports the execution of '''external analyses''' conforming to the [https://github.com/lttng/lami-spec/blob/v1.0.1/lami.adoc LAMI 1.0.x specification]. This includes recent versions of the [https://github.com/lttng/lttng-analyses LTTng-Analyses project].
 
-An external analysis is a [[#Run an External Analysis|program executed by Trace Compass]]. When the program is done analyzing, Trace Compass generates a '''[[#Open a Report|report]]''' containing its results. A report contains one or more tables which can also be viewed as bar and scatter [[#Create a Chart from a Result Table|charts]].
+An external analysis is a [[#Running an External Analysis|program executed by Trace Compass]]. When the program is done analyzing, Trace Compass generates a '''[[#Opening a Report|report]]''' containing its results. A report contains one or more tables which can also be viewed as bar and scatter [[#Creating a Chart from a Result Table|charts]].
 
 '''Note''': The program to execute is found by searching the directories listed in the standard <code>$PATH</code> environment variable when no path separator (<code>/</code> on Unix and OS X, <code>\</code> on Windows) is found in its command.
 
 Trace Compass ships with a default list of ''descriptors'' of external analyses (not the analyses themselves), including the descriptors of the [http://github.com/lttng/lttng-analyses LTTng analyses]. If the LTTng analyses project is installed, its analyses are available when opening or importing an LTTng kernel trace.
 
-=== Run an External Analysis ===
+=== Running an External Analysis ===
 
 To run an external analysis:
 
@@ -877,33 +877,33 @@ To run an external analysis:
 
 Note that many external analyses can be started concurrently.
 
-When the external analysis is done analyzing, its results are saved as a [[#Open a Report|report]] in Trace Compass. The tables contained in this report are also automatically opened into a new report view when the analysis is finished.
+When the external analysis is done analyzing, its results are saved as a [[#Opening a Report|report]] in Trace Compass. The tables contained in this report are also automatically opened into a new report view when the analysis is finished.
 
-=== Open a Report ===
+=== Opening a Report ===
 
-A '''report''' is created after a successful [[#Run an External Analysis|execution of an external analysis]].
+A '''report''' is created after a successful [[#Running an External Analysis|execution of an external analysis]].
 
 To open a report:
 
 * Under ''Reports'' under a trace in the [[#Project Explorer View]], double-click the report to open.<p>Each result table generated by the external analysis is shown in its own tab in the opened report view.</p><p>[[Image:images/externalAnalyses/report-view.png]]</p>
 
-=== Create a Chart from a Result Table ===
+=== Creating a Chart from a Result Table ===
 
 To create a bar or a scatter chart from the data of a given result table:
 
-# [[#Open a Report|Open the report]] containing the result table to use for creating the chart.
+# [[#Opening a Report|Open the report]] containing the result table to use for creating the chart.
 # In the opened report view, click the tab of the result table to use for creating the chart.
 # Click the ''View Menu'' button, then click either '''New custom bar chart''' or '''New custom scatter chart'''.<p>[[Image:images/externalAnalyses/new-custom-scatter-chart-menu.png]]</p>
 # In the opened ''Bar chart series creation'' or ''Scatter chart series creation'' window, under ''Series creator'', select a column to use for the X axis of the chart, and one or more columns to use for the Y axis of the chart, then click '''Add''' to create a series.<p>[[Image:images/externalAnalyses/chart-configuration-dialog.png]]</p><p>Repeat this step to create more series.</p>
 # Click '''OK''' to create the chart.<p>The chart is created and shown at the right of its source result table.</p><p>[[Image:images/externalAnalyses/table-and-chart.png]]</p>
 
-=== Show or Hide a Result Table ===
+=== Showing or Hiding a Result Table ===
 
-To show or hide a result table once a [[#Create a Chart from a Result Table|chart]] has been created:
+To show or hide a result table once a [[#Creating a Chart from a Result Table|chart]] has been created:
 
 * In the report view, click the ''Toggle the Table view of the results'' button.<p>[[Image:images/externalAnalyses/table-and-chart-toggle-button.png]]</p><p>If the result table was visible, it is now hidden:</p><p>[[Image:images/externalAnalyses/chart-only.png]]</p>
 
-=== Add and Remove a User-Defined External Analysis ===
+=== Adding and Removing a User-Defined External Analysis ===
 
 You can add a user-defined external analysis to the current list of external analyses. Note that the command to invoke must conform to the machine interface of [http://github.com/lttng/lttng-analyses LTTng analyses] 0.4.
 
This page took 0.02939 seconds and 5 git commands to generate.