Document the -Dtarget-platform option in the README

[deliverable/tracecompass.git] / README.md

diff --git a/README.md b/README.md
index 660a93b08f0107a0b1ae7fda1d8e9a7a0840c279..06c9ba97a89e9485c61002f1518b4d47e5ca20af 100644 (file)
--- a/README.md
+++ b/README.md
@@ -60,10 +60,18 @@ These commands will also build the p2 update site, which will be placed in
 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