From: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
Date: Wed, 28 Jan 2015 21:02:27 +0000 (-0500)
Subject: rcp: Update documentation
X-Git-Url: http://git.efficios.com/?a=commitdiff_plain;h=63a4393f4081cecef13485fdd89ce54ab2f331b5;p=deliverable%2Ftracecompass.git

rcp: Update documentation

* Refer to "Trace Compass" instead of the previous
  "Linux Tools Trace Viewer" naming.
* Add a small section describing how to update the program.

Change-Id: I916d1c6d6615cf601ba1df5210294c838d87660a
Signed-off-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
Reviewed-on: https://git.eclipse.org/r/40568
Reviewed-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
Tested-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
Reviewed-by: Hudson CI
Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
Tested-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
---

diff --git a/org.eclipse.tracecompass.rcp.help/build.xml b/org.eclipse.tracecompass.rcp.help/build.xml
index fa64be0794..94a14de0f1 100644
--- a/org.eclipse.tracecompass.rcp.help/build.xml
+++ b/org.eclipse.tracecompass.rcp.help/build.xml
@@ -7,7 +7,7 @@
     <!-- Set correct values -->
     <property name="help.doc.url.base" value="http://wiki.eclipse.org" />
     <property name="ug.path"  value="Linux_Tools_Project/Trace_Viewer/User_Guide" />
-    <property name="ug.title" value="Trace Viewer User Guide" />
+    <property name="ug.title" value="Trace Compass RCP User Guide" />
 
     <path id="wikitext.tasks.classpath">
         <!-- Search in the local Eclipse plugins directory for the Wikitext plugin -->
@@ -25,7 +25,7 @@
     <!-- Different location in more recent versions of Mylyn (Luna ?) -->
     <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
 
-    <target name="build" description="Generate Eclipse help content for the Linux Tools Trace Viewer User Guide">
+    <target name="build" description="Generate Eclipse help content for the Trace Compass RCP User Guide">
         <wikitext-to-eclipse-help markupLanguage="MediaWiki"
                 validate="true"
                 failonvalidationerror="true"
diff --git a/org.eclipse.tracecompass.rcp.help/doc/User-Guide.mediawiki b/org.eclipse.tracecompass.rcp.help/doc/User-Guide.mediawiki
index 35dcb41bf7..cae3cbfafd 100644
--- a/org.eclipse.tracecompass.rcp.help/doc/User-Guide.mediawiki
+++ b/org.eclipse.tracecompass.rcp.help/doc/User-Guide.mediawiki
@@ -1,34 +1,41 @@
 = Overview =
-The Linux Tools Trace Viewer is a stand-alone application based on Eclipse's
+The Trace Compass RCP version is a stand-alone application based on Eclipse's
 Rich Client Platform (RCP). The purpose of this is to provide a lightweight
-application to view and analyze traces. It includes all TMF (Tracing and
-Monitoring Framework) features, as well as all features from the LTTng (Linux
-Tracing Toolkit next generation) Eclipse integration, which are provided by the
-Linux Tools Project.
+application to view and analyze traces. It includes most standard features found
+in the Trace Compass project.
 
 = Getting Started =
-To start the Linux Tools Trace Viewer, go to the directory where the Trace
-Viewer is installed and then run the application named '''traceViewer'''.
-During startup, the Trace Viewer will create, if necessary, an Eclipse workspace
-in the user's home directory with the name ''.traceviewer''. It also creates, if
-needed, a default tracing project called ''Tracing''.
+To start the Trace Compass RCP, go to the directory where it is installed and
+then run the executable named '''tracecompass'''. During startup, the program
+will create, if necessary, an Eclipse workspace under the user's home directory
+with the name ''.tracecompass''. It also creates, if needed, a default tracing
+project called ''Tracing''.
 
-Now the application can be used as described in the User Guide for Linux Tools
-LTTng integration (see section [[#References | References]]).
+Now the application can be used as described in the regular User Guide. (see
+section [[#References | References]]).
+
+= Updating the application =
+The RCP is pre-configured to point to the update site of its release "track".
+For example, if you download a "nightly" RCP, it will update using that
+"nightly" update site. These settings are configurable in the preferences, but
+in most cases, the user should not have to change them.
+
+The program does not check automatically for updates. To check manually, you can
+click on '''Help''' -> '''Check for Updates'''. If updates are available, a
+standard Eclipse update dialog will offer their installation.
 
 = Opening a Trace =
 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
+A new dialog will show up 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
+be selected to open the trace. The auto detection algorithm will then 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 '''tracecompass''' with the command-line
 argument '''--open <trace-path>'''. The trace will then automatically open 
 using the same algorithm than described above.
 
@@ -36,6 +43,6 @@ In both of the above cases, the trace will be linked to the default project.
 
 = References =
 
-* [http://www.eclipse.org/linuxtools/projectPages/lttng/ Linux Tools - LTTng integration]
+* [http://www.eclipse.org/tracecompass Trace Compass project]
 * [http://www.lttng.org/ LTTng project]