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, you first need to build the Linux Tools target definition
  23  (starting from the root of the source tree):
  24 $ cd releng/org.eclipse.linuxtools.target
  25 $ mvn clean install
  26 Then you can build the LTTng plugins:
  27 $ cd ../../lttng
  28 $ mvn clean install
  29
  30 As long as you don't clear the Maven reactor cache (in ~/.m2), you should not
  31 need to rebuild the target definition.
  32
  33
  34 The default command will compile and run the unit tests. Running the tests can
  35 take some time, to skip them you can append "-Dmaven.test.skip=true" to the
  36 'mvn' command:
  37 $ mvn clean install -Dmaven.test.skip=true
  38
  39
  40 The RCP is not built by default, to build it you need to add "-PtracingRcp" to
  41 the 'mvn' command:
  42 $ mvn clean install -PtracingRcp -Dmaven.test.skip=true
  43
  44 This will build the RCP for all supported architectures. The resulting archives
  45 will be placed in lttng/org.eclipse.linuxtools.tracing.rcp.product/target/products
  46
  47
  48 To build a local p2 update site (LTTng integration only)
  49 $ mvn clean install -PlttngPackage
  50
  51 This will place the p2 update site under the default location
  52 /var/www/tools/linuxtools/lttng/update-nightly/
  53
  54 To change the package location, use:
  55 $ mvn clean install -PlttngPackage "-DlttngPackageDestination=<package destination>"
  56
  57 where <package destination> is the absolute path to destination directory on your disk.
  58