Latest revision as of 21:52, 9 July 2008

Contents

Template Usage Steps

First, you need to get a copy of the template. Copy /cvsroot/modeling/releng-common/templates/org.eclipse._PROJECTNAMESPACE_.releng to
/cvsroot/_TOPPROJECTNAME_/org.eclipse._PARENTPROJECTNAME_/org.eclipse._PROJECTNAMESPACE_.releng,
where:

_TOPPROJECTNAME_ = "modeling", "tools", "technology", etc.

_PARENTPROJECTNAME_ = "mdt", "m2t", "gef", "pdt", etc.

_PROJECTNAMESPACE_ is defined below.

NOTE: Some of the variables listed below apply to the .doc (or other) template, not the .releng template. YMMV.

Next, clean up the template for your specific needs:

Find and rename all files with _SHORTNAME_ in their name, using the project's shortname

promoteToEclipse._SHORTNAME_.properties

templateFiles/_SHORTNAME_.map.template

maps/_SHORTNAME_.map

Find and replace all occurrences in all files of the string "_TOPPROJECTNAME_" with your top project's name.

Find and replace all occurrences in all files of the string "_PARENTPROJECTNAME_" with your parent project's name.

Find and replace all occurrences in all files of the string "_SHORTNAME_" with your project's shortname.

Ensure that if you are properly configured for the JDK you require (1.4, 5.0) (see TODOs)

If necessary, you can manually copy files from the SDK into the other zips (see TODO)

If necessary, you should remove 3rd party jars used at build time from the zips (see TODO)

Additional changes may be required. For examples, see these projects:

JDK 1.4: eodm, jeteditor

JDK 5.0 and JDK 1.4: ocl, query, validation, transaction, jet

(5.0 used in 1.1/0.8 development streams,

1.4 used in 1.0/0.7 maintenance streams)

JDK 5.0: cdo, net4j

Edit builder/*/build.properties to ensure they are configured for the correct JDK version (see TODO)

Edit builder/*/customTargets.xml:

Ensure all requirements are downloaded and unpacked as needed (see TODO)

Edit builder/tests/configs/local/customTest.xml to ensure all requirements are downloaded and unpacked as needed (see TODO)

Edit builder/tests/configs/local/testing.properties to ensure proper JDK and vmflags are set (see TODOs)

Edit builder/tests/scripts/test.xml:

ensure all requirements are downloaded and unpacked as needed (see TODO)

ensure if your test plugin is jarred you (un)comment out the appropriate lines (see TODOs)

Doc Plugin & Feature Builder

Updated: As of 2007-07-12, there's now a full template for both doc plugin and doc feature that you can use to create the required stuff you need for your doc plugin in order to get at least javadoc (if you don't have any other documents available yet).