README

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