X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=README.md;h=04a1ced64dcb0f8cf189f1aeeec591273483bd96;hb=6e9f07080e616b425b065d042b903580644c8eb6;hp=660a93b08f0107a0b1ae7fda1d8e9a7a0840c279;hpb=59e6f2ce576c9a5e9b436b4004a6d0834cf6d047;p=deliverable%2Ftracecompass.git diff --git a/README.md b/README.md index 660a93b08f..04a1ced64d 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,10 @@ wiki page: Compiling manually ------------------ -To build the plugins manually using Maven, simply run the following command from +The Maven project build requires version 3.3 or later. It can be downloaded from + or from the package management system of your distro. + +To build the project manually using Maven, simply run the following command from the top-level directory: mvn clean install @@ -45,39 +48,42 @@ take some time, to skip them you can append `-Dmaven.test.skip=true` to the 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 `rcp/org.eclipse.tracecompass.rcp.product/target/products`. +Stand-alone application (RCP) packages will be placed in +`rcp/org.eclipse.tracecompass.rcp.product/target/products`. -These commands will also build the p2 update site, which will be placed in -`releng/org.eclipse.tracecompass.releng-site/target/repository`. +The p2 update site, used for installation as plugins inside Eclipse, will be +placed in `releng/org.eclipse.tracecompass.releng-site/target/repository`. Maven profiles and properties ----------------------------- -The following Maven profiles, and their corresponding properties, are defined in +The following Maven profiles and properties are defined in the build system. You can set them by using `-P[profile name]` and `-D[property name]=[value]` in `mvn` commands. +* `-Dtarget-platform=[target]` + + Defines which target to use. This is used to build against various versions of + the Eclipse platform. Available ones are in + `releng/org.eclipse.tracecompass.target`. The default is usually the latest + stable platform. To use the staging target for example, use + `-Dtarget-platform=tracecompass-eStaging`. + * `-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` +* `-P -build-rcp` - Builds the RCP archives. Refer to the previous section for details. + Disables the "build-rcp" profile to skip building the RCP archives. * `-Prun-custom-test-suite` Runs a test suite present in `releng/org.eclipse.tracecompass.alltests`. The test suite to run has to be defined by `-DcustomTestSuite=[name]`, for example - `-DcustomTestSuite=RunAllCoreTests`. + `-DcustomTestSuite=RunAllPerfTests`. * `-Pdeploy-rcp`