Eclipse Trace Compass

This source tree contains the source code for the Trace Compass plugins for Eclipse.

The plugins are categorized as follows:

org.eclipse.tracecompass.analysis.*    | Generic extensions to the base framework
org.eclipse.tracecompass.btf.*         | Best Trace Format (BTF) integration
org.eclipse.tracecompass.ctf.*         | Common Trace Format (CTF) reader library
org.eclipse.tracecompass.gdbtrace.*    | Support for reading and viewing GDB traces
org.eclipse.tracecompass.lttng2.*      | LTTng 2.x integration
org.eclipse.tracecompass.pcap.*        | libpcap integration
org.eclipse.tracecompass.rcp.*         | Code specific to the RCP version
org.eclipse.tracecompass.statesystem.* | State System library
org.eclipse.tracecompass.tmf.*         | Core framework

See the plugins.svg file for a diagram showing the dependencies between the different plugins.

Setting up the development environment

To set up the environment to build Trace Compass from within Eclipse, see this wiki page: http://wiki.eclipse.org/Trace_Compass/Development_Environment_Setup

Compiling manually

To build the plugins manually using Maven, simply run the following command from the top-level directory:

mvn clean install

The default command will compile and run the unit tests. Running the tests can take some time, to skip them you can append -Dmaven.test.skip=true to the mvn command:

mvn clean install -Dmaven.test.skip=true

The RCP is not built by default, to build it you need to add -Pbuild-rcp to the mvn command:

mvn clean install -Pbuild-rcp -Dmaven.test.skip=true

This will build the RCP for all supported architectures. The resulting archives will be placed in org.eclipse.tracecompass.rcp.product/target/products.

These commands will also build the p2 update site, which will be placed in org.eclipse.tracecompass.releng-site/target/repository.

Maven profiles and properties

The following Maven profiles, and their corresponding properties, are defined in the build system. You can set them by using -P[profile name] and -D[property name]=[value] in mvn commands.

• -Pctf-grammar

  Re-compiles the CTF grammar files. This should be enabled if you modify the .g files in the ctf.parser plugin.

• -Pbuild-rcp

  Builds the RCP archives. Refer to the previous section for details.

• -Pdeploy-rcp

  Mainly for use on build servers. Copies the generated RCP archives, as well as the RCP-specific update site, to the paths specified by -DrcpDestination=/absolute/path/to/destination and -DrcpSiteDestination=/absolute/path/to/destination, respectively. Must be used with -Pbuild-rcp!

• -Pdeploy-update-site

  Mainly for use on build servers. Copies the standard update site (for the Eclipse plugin installation) to the destination specified by -DsiteDestination=/absolute/path/to/destination.

• -Psign-update-site

  Mainly for use on build servers. Signs all the generated update sites using the Eclipse signing server.

• -Pdeploy-doc

  Mainly for use on build servers. Copies the generated HTML documentation to the destination specified by -DdocDestination=/absolute/path/to/destination. Some directories may need to already exist at the destination (or Maven will throw related errors).