Commit | Line | Data |
---|---|---|
4c7ca017 AM |
1 | Eclipse Trace Compass |
2 | ===================== | |
3 | ||
4 | This source tree contains the source code for the Trace Compass plugins for | |
5 | Eclipse. | |
6 | ||
7 | The plugins are categorized as follows: | |
8 | ||
9 | org.eclipse.tracecompass.analysis.* | Generic extensions to the base framework | |
10 | org.eclipse.tracecompass.btf.* | Best Trace Format (BTF) integration | |
11 | org.eclipse.tracecompass.ctf.* | Common Trace Format (CTF) reader library | |
12 | org.eclipse.tracecompass.gdbtrace.* | Support for reading and viewing GDB traces | |
13 | org.eclipse.tracecompass.lttng2.* | LTTng 2.x integration | |
14 | org.eclipse.tracecompass.pcap.* | libpcap integration | |
15 | org.eclipse.tracecompass.rcp.* | Code specific to the RCP version | |
16 | org.eclipse.tracecompass.statesystem.* | State System library | |
17 | org.eclipse.tracecompass.tmf.* | Core framework | |
18 | ||
19 | See the `plugins.svg` file for a diagram showing the dependencies between the | |
20 | different plugins. | |
21 | ||
22 | ||
23 | Setting up the development environment | |
24 | -------------------------------------- | |
25 | ||
26 | To set up the environment to build Trace Compass from within Eclipse, see this | |
27 | wiki page: | |
28 | <http://wiki.eclipse.org/Trace_Compass/Development_Environment_Setup> | |
29 | ||
30 | ||
31 | Compiling manually | |
32 | ------------------ | |
33 | ||
34 | To build the plugins manually using Maven, simply run the following command from | |
35 | the top-level directory: | |
36 | ||
37 | mvn clean install | |
38 | ||
39 | The default command will compile and run the unit tests. Running the tests can | |
40 | take some time, to skip them you can append `-Dmaven.test.skip=true` to the | |
41 | `mvn` command: | |
42 | ||
43 | mvn clean install -Dmaven.test.skip=true | |
44 | ||
45 | ||
46 | The RCP is not built by default, to build it you need to add `-Pbuild-rcp` to | |
47 | the `mvn` command: | |
48 | ||
49 | mvn clean install -Pbuild-rcp -Dmaven.test.skip=true | |
50 | ||
51 | This will build the RCP for all supported architectures. The resulting archives | |
52 | will be placed in `org.eclipse.tracecompass.rcp.product/target/products`. | |
53 | ||
54 | ||
55 | To build a local p2 update site: | |
56 | ||
56a48bdb | 57 | mvn clean install -Pdeploy-update-site "-DsiteDestination=/path/to/destination" |
4c7ca017 AM |
58 | |
59 | where `/path/to/destination` is the **absolute** path to destination directory | |
60 | on your disk. | |
61 |