X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=README.md;h=432836a6bf87f0854b22927e7a90c03c78f5f76f;hb=refs%2Fheads%2Fpin-views;hp=a902b33eb982bec361758ee646504434ee10d583;hpb=5be236cadecbdb4c7fbe94717b81a3818c3d029d;p=deliverable%2Ftracecompass.git

diff --git a/README.md b/README.md
index a902b33eb9..432836a6bf 100644
--- a/README.md
+++ b/README.md
@@ -6,18 +6,21 @@ Eclipse.
 
 The plugins are categorized as follows:
 
-    org.eclipse.tracecompass.analysis.*    | Generic extensions to the base framework
-    org.eclipse.tracecompass.btf.*         | Best Trace Format (BTF) integration
-    org.eclipse.tracecompass.ctf.*         | Common Trace Format (CTF) reader library
-    org.eclipse.tracecompass.gdbtrace.*    | Support for reading and viewing GDB traces
-    org.eclipse.tracecompass.lttng2.*      | LTTng 2.x integration
-    org.eclipse.tracecompass.pcap.*        | libpcap integration
-    org.eclipse.tracecompass.rcp.*         | Code specific to the RCP version
-    org.eclipse.tracecompass.statesystem.* | State System library
-    org.eclipse.tracecompass.tmf.*         | Core framework
-
-See the `plugins.svg` file for a diagram showing the dependencies between the
-different plugins.
+    analysis/    | Generic extensions to the base framework
+    btf/         | Best Trace Format (BTF) integration
+    common/      | Generic utilities that can be used by other plugins
+    ctf/         | Common Trace Format (CTF) reader library
+    doc/         | Documentation and code examples
+    gdbtrace/    | Support for reading and viewing GDB traces
+    lttng/       | LTTng integration
+    pcap/        | libpcap integration
+    rcp/         | Code specific to the RCP version
+    releng/      | Releng-related plugins
+    statesystem/ | State System library
+    tmf/         | Core framework
+
+See the `components.svg` file for a diagram showing the dependencies between the
+different components.
 
 
 Setting up the development environment
@@ -31,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
+<http://maven.apache.org> 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
@@ -42,33 +48,48 @@ 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
+Stand-alone application (RCP) packages will be placed in
+`rcp/org.eclipse.tracecompass.rcp.product/target/products`.
 
-This will build the RCP for all supported architectures. The resulting archives
-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
-`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`.
+
+* `-Dskip-automated-ui-tests`
+
+  Skips the automated UI integration tests. Not required when using
+  `-Dmaven.test.skip=true`, which already skips all the tests.
+
+* `-Dskip-rcp`
+
+  Skips building the RCP archives and related deployment targets. Only works in
+  conjunction with `-Dskip-automated-ui-tests`, due to a limitation in Maven.
+
 * `-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`
+* `-Prun-custom-test-suite`
 
-  Builds the RCP archives. Refer to the previous section for details.
+  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=RunAllPerfTests`.
 
 * `-Pdeploy-rcp`
 
@@ -76,7 +97,6 @@ the build system. You can set them by using `-P[profile name]` and
   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`