README

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