From 424f59c487d1744caff17f46f4f9a240c54204c5 Mon Sep 17 00:00:00 2001 From: Alexandre Montplaisir Date: Wed, 4 Feb 2015 17:17:32 -0500 Subject: [PATCH] Document the different profiles in the README Change-Id: I1d211fa7607f073b12b6cf27c371308a3546c654 Signed-off-by: Alexandre Montplaisir Reviewed-on: https://git.eclipse.org/r/41106 Reviewed-by: Marc-Andre Laperle --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 42 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2f8a2f7259..7e14b1e780 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,6 @@ 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: @@ -51,11 +50,49 @@ the `mvn` command: 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` -To build a local p2 update site: + Mainly for use on build servers. Signs all the generated update sites using + the Eclipse signing server. - mvn clean install -Pdeploy-update-site "-DsiteDestination=/path/to/destination" +* `-Pdeploy-doc` -where `/path/to/destination` is the **absolute** path to destination directory -on your disk. + 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). -- 2.34.1