Difference between revisions of "DTP Releng Instructions"

Latest revision as of 01:51, 16 April 2008

How to Build DTP from CVS

This page mainly decribes how to set up headless PDE build system for DTP and start the build. Since the build server is a Linux server, below instructions are based on Linux environment.

Prerequisites

1. CVS version 1.10 or higher.
2. 1.4.2 level JDK. (DTP 1.6 uses Java compiler compliance level 1.4 .)
3. Info-Zip zip and unzip.
4. org.eclipse.releng.basebuilder.
5. org.eclipse.datatools.releng.builder.
6. Eclipse 3.3.2 SDK
7. EMF 2.2(emf+sdo)
8. GEF 3.3

Setup

1. Add the zip, unzip, tar, gzip and cvs executables to your path as required.
2. Add the jre/bin directory of the installed JDK to your path.
3. Check out org.eclipse.releng.basebuilder and org.eclipse.dtp.releng.builder into local server.
We recommend to use tagged version of org.eclipse.releng.basebuilder. The HEAD version is not stable and may have changes which will lead to build failure. The examples below are tested with tag version vI20070209-1006
4. Create a new directory as baseLocation.
5. Extract Eclipse SDK, EMF, GEF into baseLocation. The root folder should be plugins/ and features/.

Start the Build

cd to org.eclipse.dtp.releng.builder directory and execute the following command to start the build

  ./bootstrap.sh N

This shell script actually excutes below command, which will invode the top-level build script buildAll.xml:

  buildCommand="$antRunner -q -buildfile buildAll.xml $mail $testBuild $compareMaps 

  -DmapVersionTag=$mapVersionTag -DpostingDirectory=$postingDirectory 

  -Dbootclasspath=$bootclasspath -DbuildType=$buildType -D$buildType=true 

  -DbuildId=$buildId -Dbuildid=$buildId -DbuildLabel=$buildId -Dtimestamp=$timestamp $tagMaps 

  -DJ2SE-1.5=$bootclasspath_15  -DlogExtension=.xml $updateSite 

  -Djava15-home=$bootclasspath_15 -DbuildDirectory=/home/adb/releng.dtp/src 

  -DbaseLocation=/home/adb/releng.dtp/baseLocation 

  -DgroupConfiguration=true -DjavacVerbose=true 

  -Dbasebuilder=/home/adb/releng.dtp/org.eclipse.releng.basebuilder 

  -Djvm15_home=$jvm15_home 
  -DmapTag.properties=/home/adb/releng.dtp/org.eclipse.datatools.releng.builder/mapTag.properties 

  -Dbuild.date=$builddate -Dpackage.version=1.6M6-$timestamp 

  -DmapCvsRoot=:ext:anonymouse@dev.eclipse.org:/cvsroot/datatools 

  -DmapVersionTag=HEAD -DjavacTarget=1.4 -DjavacSource=1.4"

Note that, before starting the build, environment variable in bootstrap.sh and build.properties need to be set correctly according to your local server. Please seeAnt Properties Settings part.

Top-level Build Script Analysis

Let's take a look at the top-level buildAll.xml which drives the whole build actually.

       <target name="main" depends="init">
               <antcall target="buildDtpSdkAllFeature"/>
               <antcall target="buildDtpEnablementAllFeature"/>
               <antcall target="integrateDtpFeatures"/>
               <antcall target="Package"/>
               <antcall target="GenerateUpdateSite"/>
       </target>

Target buildDtpSdkAllFeature will build the component dtp.sdk.all. The fake top-level feature org.eclipse.datatools.sdk-all.feature will drive the building of this component.

    <target name="buildDtpSdkAllFeature">
        <ant antfile="build.xml" dir="${basedir}">
            <property name="component" value="${eclipse.build.configs}/dtp.sdk.all" />
        </ant>
    </target>

Target buildDtpEnablementAllFeature will build the component dtp.enablement.all. The fake top-level feature org.eclipse.datatools.enablement-all.feature will drive the building of this component.

    <target name="buildDtpEnablementFeature">
        <ant antfile="build.xml" dir="${basedir}">
            <property name="component" value="${eclipse.build.configs}/dtp.enablement" />
        </ant>
    </target>

Target integrateDtpFeatures will unzip the output packages of above two component's build into same directory.

Target Package will generate the final delivery dtp package: sdk package and non-sdk package, including repackage the source plugins.

Target GenerateUpdateSite will generate the update site.

Component Introduction

From a user's perspective, DTP has two top level features: the SDK and Enablement. From a build perspective, Enablement depends on most of what is contained in the SDK feature.

So we have two component in org.eclipse.datatools.releng.builder and the build order is dtp.sdk.all -> dtp.enablement.all.

org.eclipse.datatools.sdk.feature

org.eclipse.datatools.intro

org.eclipse.datatools.doc.user

source features

org.eclipse.datatools.enablement.feature

source features of enablement features

Ant Properties Settings

The following properties are pre-defined in the build.properties file for the specified component. They can be overridden by setting them at the command line at build time or by changing them directly in the component's build.properties file. Value set in build.properties will be overriden by the one set in command line (or in bootstrap.sh).

Generating Source Features and Plugins

We use PDE tools to generate source features and source plugins automatically. Please click here to see how this works.

build.properties of sdk-all.feature and enablement-all.feature has contained the setting for generating source features.

Build Server Directory Structure