projects / deliverable / tracecompass.git / blame
| 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 | ||
| 4c7ca017 AM |
45 | The RCP is not built by default, to build it you need to add `-Pbuild-rcp` to |
| 46 | the `mvn` command: | |
| 47 | ||
| 48 | mvn clean install -Pbuild-rcp -Dmaven.test.skip=true | |
| 49 | ||
| 50 | This will build the RCP for all supported architectures. The resulting archives | |
| 51 | will be placed in `org.eclipse.tracecompass.rcp.product/target/products`. | |
| 52 | ||
| 424f59c4 AM |
53 | These commands will also build the p2 update site, which will be placed in |
| 54 | `org.eclipse.tracecompass.releng-site/target/repository`. | |
| 55 | ||
| 56 | ||
| 57 | Maven profiles and properties | |
| 58 | ----------------------------- | |
| 59 | ||
| 60 | The following Maven profiles, and their corresponding properties, are defined in | |
| 61 | the build system. You can set them by using `-P[profile name]` and | |
| 62 | `-D[property name]=[value]` in `mvn` commands. | |
| 63 | ||
| 64 | * `-Pctf-grammar` | |
| 65 | ||
| 66 | Re-compiles the CTF grammar files. This should be enabled if you modify the | |
| 67 | `.g` files in the `ctf.parser` plugin. | |
| 68 | ||
| 69 | * `-Pbuild-rcp` | |
| 70 | ||
| 71 | Builds the RCP archives. Refer to the previous section for details. | |
| 72 | ||
| 73 | * `-Pdeploy-rcp` | |
| 74 | ||
| 75 | Mainly for use on build servers. Copies the generated RCP archives, as well as | |
| 76 | the RCP-specific update site, to the paths specified by | |
| 77 | `-DrcpDestination=/absolute/path/to/destination` and | |
| 78 | `-DrcpSiteDestination=/absolute/path/to/destination`, respectively. | |
| 79 | Must be used with `-Pbuild-rcp`! | |
| 80 | ||
| 81 | * `-Pdeploy-update-site` | |
| 82 | ||
| 83 | Mainly for use on build servers. Copies the standard update site (for the | |
| 84 | Eclipse plugin installation) to the destination specified by | |
| 85 | `-DsiteDestination=/absolute/path/to/destination`. | |
| 86 | ||
| 87 | * `-Psign-update-site` | |
| 4c7ca017 | 88 | |
| 424f59c4 AM |
89 | Mainly for use on build servers. Signs all the generated update sites using |
| 90 | the Eclipse signing server. | |
| 4c7ca017 | 91 | |
| 424f59c4 | 92 | * `-Pdeploy-doc` |
| 4c7ca017 | 93 | |
| 424f59c4 AM |
94 | Mainly for use on build servers. Copies the generated HTML documentation to |
| 95 | the destination specified by `-DdocDestination=/absolute/path/to/destination`. | |
| 96 | Some directories may need to already exist at the destination (or Maven will | |
| 97 | throw related errors). | |
| 4c7ca017 | 98 |