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