Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLars Vogel2018-12-03 03:57:53 -0500
committerLars Vogel2018-12-15 04:56:46 -0500
commita31928addca50e39c2dbcbcddef32cf5f0f2644f (patch)
tree265ab3a50d9f3380098da14caf2d227b645a9725
parent4f232a107e8c26f097bb040f43771f0bdaf6ad31 (diff)
downloadeclipse.platform.releng.aggregator-a31928addca50e39c2dbcbcddef32cf5f0f2644f.tar.gz
eclipse.platform.releng.aggregator-a31928addca50e39c2dbcbcddef32cf5f0f2644f.tar.xz
eclipse.platform.releng.aggregator-a31928addca50e39c2dbcbcddef32cf5f0f2644f.zip
Bug 541808 - Move scripts/build.sh to Readme.md
Change-Id: I7920e8af0072878fb488e65ef03cbf04737996f3 Signed-off-by: Lars Vogel <Lars.Vogel@vogella.com>
-rw-r--r--README.md69
-rwxr-xr-xscripts/build.sh19
2 files changed, 50 insertions, 38 deletions
diff --git a/README.md b/README.md
index 62d5d693..203d4072 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,50 @@
-eclipse.platform.releng.aggregator
-==================================
-
-Aggregator repo for Eclipse SDK builds.
-
-To run a complete build, on your local machine, run the commands from ./scripts/build.sh in this folder.
-
-These commands requires the installation and setup of Java 1.8 or higher and Maven version 3.5.4 or higher Plus, other settings, alternatives, and other recommendations are made in the complete instructions on the [Platform Build wiki](http://wiki.eclipse.org/Platform-releng/Platform_Build "Platform Build"). Note, it is highly recommended to use toolchains.xml and -Pbree-libs as decribed in [Using BREE Libs](https://wiki.eclipse.org/Platform-releng/Platform_Build#Using_BREE_Libs "Using BREE Libs"). If you do use BREE Libs (with proper toolchains.xml file) you can use Java 1.7 to "run the build".
-
-Eclipse Platform Project committers should also read [Automated Platform Builds](http://wiki.eclipse.org/Platform-releng/Automated_Platform_Build "Automated Platform Builds").
-
-Release Engineers should also be familiar with other documents on the [Releng Wiki](http://wiki.eclipse.org/Category:Eclipse_Platform_Releng "Releng Wiki").
-
-License
--------
-
-[Eclipse Public License (EPL) v1.0][2]
-
-[2]: http://wiki.eclipse.org/EPL
+eclipse.platform.releng.aggregator
+==================================
+
+Aggregator repo for Eclipse SDK builds.
+
+How to build the Eclipse SDK
+----------------------------
+
+To run a complete build, on your local machine, run the following commands.
+The `-DskipTests=true` will skip the tests which take a significant time to run, e.g., up to 10 hours.
+
+```
+# clean up "dirt" from previous build see Bug 420078
+git submodule foreach git clean -f -d -x
+git submodule foreach git reset --hard HEAD
+git clean -f -d -x
+git reset --hard HEAD
+
+# update master and submodules
+git checkout master
+git pull --recurse-submodules
+git submodule update
+
+# run the build
+mvn clean verify -DskipTests=true
+
+# find the results in
+# eclipse.platform.releng.tychoeclipsebuilder/sdk/target/products/*
+```
+
+Build requirements
+------------------
+
+The build commands require the installation and setup of Java 1.8 or higher and Maven version 3.5.4 or higher.
+See also the complete instructions on the [Platform Build wiki](http://wiki.eclipse.org/Platform-releng/Platform_Build "Platform Build").
+Note, it is highly recommended to use toolchains.xml and -Pbree-libs as decribed in [Using BREE Libs](https://wiki.eclipse.org/Platform-releng/Platform_Build#Using_BREE_Libs "Using BREE Libs").
+
+Additional informations
+-----------------------
+
+Eclipse Platform Project committers should also read [Automated Platform Builds](http://wiki.eclipse.org/Platform-releng/Automated_Platform_Build "Automated Platform Builds").
+
+Release Engineers should also be familiar with other documents on the [Releng Wiki](http://wiki.eclipse.org/Category:Eclipse_Platform_Releng "Releng Wiki").
+
+License
+-------
+
+[Eclipse Public License (EPL) v1.0][2]
+
+[2]: http://wiki.eclipse.org/EPL
diff --git a/scripts/build.sh b/scripts/build.sh
deleted file mode 100755
index 56c66522..00000000
--- a/scripts/build.sh
+++ /dev/null
@@ -1,19 +0,0 @@
-#!/bin/bash
-
-clean up "dirt" from previous build
-# see Bug 420078
-git submodule foreach git clean -f -d -x
-git submodule foreach git reset --hard HEAD
-git clean -f -d -x
-git reset --hard HEAD
-
-# update master and submodules
-git checkout master
-git pull --recurse-submodules
-git submodule update
-
-# run the build
-mvn clean verify
-
-# find the results in
-# eclipse.platform.releng.tychoeclipsebuilder/sdk/target/products/*

Back to the top