projects / deliverable / tracecompass.git / blame
| Commit | Line | Data |
|---|---|---|
| 2b042910 | 1 | = Overview = |
| 63a4393f | 2 | The Trace Compass RCP version is a stand-alone application based on Eclipse's |
| 2b042910 | 3 | Rich Client Platform (RCP). The purpose of this is to provide a lightweight |
| 63a4393f AM |
4 | application to view and analyze traces. It includes most standard features found |
| 5 | in the Trace Compass project. | |
| 2b042910 BH |
6 | |
| 7 | = Getting Started = | |
| 63a4393f AM |
8 | To start the Trace Compass RCP, go to the directory where it is installed and |
| 9 | then run the executable named '''tracecompass'''. During startup, the program | |
| 10 | will create, if necessary, an Eclipse workspace under the user's home directory | |
| 11 | with the name ''.tracecompass''. It also creates, if needed, a default tracing | |
| 12 | project called ''Tracing''. | |
| 2b042910 | 13 | |
| 63a4393f AM |
14 | Now the application can be used as described in the regular User Guide. (see |
| 15 | section [[#References | References]]). | |
| 16 | ||
| 17 | = Updating the application = | |
| 18 | The RCP is pre-configured to point to the update site of its release "track". | |
| 19 | For example, if you download a "nightly" RCP, it will update using that | |
| 20 | "nightly" update site. These settings are configurable in the preferences, but | |
| 21 | in most cases, the user should not have to change them. | |
| 22 | ||
| 23 | The program does not check automatically for updates. To check manually, you can | |
| 24 | click on '''Help''' -> '''Check for Updates'''. If updates are available, a | |
| 25 | standard Eclipse update dialog will offer their installation. | |
| 2b042910 | 26 | |
| 76fccfb0 | 27 | = Opening a Trace = |
| 1aec2e92 | 28 | To open a trace, click on the '''File''' menu and select '''Open Trace...'''. |
| 63a4393f | 29 | A new dialog will show up for selecting a trace to open. Select a trace file |
| 1aec2e92 BH |
30 | and then click on '''OK'''. Note that for traces that are directories |
| 31 | (such as Common Trace Format (CTF) traces) any file in the trace directory can | |
| 63a4393f AM |
32 | be selected to open the trace. The auto detection algorithm will then validate |
| 33 | the trace against all known trace types. If multiple trace types are valid, a | |
| 34 | trace type is chosen based on a confidence criteria. The validation process and | |
| 35 | the computation of the confidence level are trace type specific. After | |
| 36 | successful validation, the trace will be opened with the detected trace type. | |
| 37 | ||
| 38 | Alternatively the user can launch '''tracecompass''' with the command-line | |
| d3e89107 BH |
39 | argument '''--open <trace-path>'''. The trace will then automatically open |
| 40 | using the same algorithm than described above. | |
| 76fccfb0 MK |
41 | |
| 42 | In both of the above cases, the trace will be linked to the default project. | |
| 43 | ||
| 2b042910 BH |
44 | = References = |
| 45 | ||
| 63a4393f | 46 | * [http://www.eclipse.org/tracecompass Trace Compass project] |
| 2b042910 | 47 | * [http://www.lttng.org/ LTTng project] |
| 2b042910 | 48 |