tmf: Move plugins to the Trace Compass namespace

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tracing.rcp.help / doc / User-Guide.mediawiki

diff --git a/org.eclipse.linuxtools.tracing.rcp.help/doc/User-Guide.mediawiki b/org.eclipse.linuxtools.tracing.rcp.help/doc/User-Guide.mediawiki
index f39740aeb21d59cf395853d6c2e77880708a709e..35dcb41bf7738e721a7351e76103f5692e6af0ff 100644 (file)
--- a/org.eclipse.linuxtools.tracing.rcp.help/doc/User-Guide.mediawiki
+++ b/org.eclipse.linuxtools.tracing.rcp.help/doc/User-Guide.mediawiki
@@ -17,9 +17,20 @@ Now the application can be used as described in the User Guide for Linux Tools
 LTTng integration (see section [[#References | References]]).
 
 = Opening a Trace =
-To open a trace, click on the '''File''' menu, '''Open''' and select a '''Open file...''' (logs and such) or '''Open directory...''' (Ctf trace). Select the file or directory, and the RCP will open it. It will attempt to autodetect the trace type. If many trace types can read this trace, a window will prompt the user to select a trace type. Once a trace type is selected, the trace loads.
-
-If the user prefers, they can launch the RCP with the argument '''--open <trace-path>'''. The trace will then automatically open. Conflicting trace types will be resolved the same way as opening from a menu, if there are conflicting types, the user will be prompted to select a trace type.
+To open a trace, click on the '''File''' menu and select '''Open Trace...'''.
+A new dialog will show for selecting a trace to open. Select a trace file
+and then click on '''OK'''. Note that for traces that are directories
+(such as Common Trace Format (CTF) traces) any file in the trace directory can
+be selected to open the trace. Now, the trace viewer's auto detection algorithm
+will validate the trace against all known trace types. If multiple trace types
+are valid, a trace type is chosen based on a confidence criteria. The
+validation process and the computation of the confidence level are trace type
+specific. After successful validation the trace will be opened with the
+detected trace type.
+
+Alternatively the user can launch the trace viewer with the command-line
+argument '''--open <trace-path>'''. The trace will then automatically open 
+using the same algorithm than described above.
 
 In both of the above cases, the trace will be linked to the default project.
 
@@ -27,5 +38,4 @@ In both of the above cases, the trace will be linked to the default project.
 
 * [http://www.eclipse.org/linuxtools/projectPages/lttng/ Linux Tools - LTTng integration]
 * [http://www.lttng.org/ LTTng project]
-* [http://wiki.eclipse.org/Linux_Tools_Project/TMF/User_Guide TMF User Guide]