View source for SMILA/Documentation/HowTo/Howto set up dev environment

== Howto set up dev environment ==

=== dev env ===

* ref: [[SMILA/Development Guidelines|Development Guidelines]]
* https://svn.brox.de/svn/eccenca/EILF/trunk/SMILA.builder/
* eclipse 3.3
*:  plugins needed:
*:  - extension location to WC \EILF.extension

=== Howto build and test locally ===

==== Setup an own Eclipse instance/installation for building ====

Setting up an own instance is recommended such that no extensions/features u might have installed in ur eclipse instance u use for developing interferes with the build. It probably also makes the build a little faster as the headless start of eclipse takes less time due to fewer plug-ins installed.

# Download an eclipse SDK, starting with at least [http://archive.eclipse.org/eclipse/downloads/drops/R-3.3.2-200802211800/download.php?dropFile=eclipse-SDK-3.3.2-win32.zip eclipse-SDK-3.3.2-win32.zip]
# download [http://archive.eclipse.org/eclipse/downloads/drops/R-3.3.2-200802211800/download.php?dropFile=eclipse-RCP-3.3.2-delta-pack.zip eclipse-RCP-3.3.2-delta-pack.zip] from [http://archive.eclipse.org/eclipse/downloads/drops/R-3.3.2-200802211800/index.php]
# unzip the archive and copy '''org.eclipse.equinox.executable_<version>''' from features into your features folder under your eclipse installation.
# start that eclipse and add sole extension location to WC /SMILA.extension by:
## Menu: Help / Software Updates / Manage configuration
## add extension location and choose the folder SMILA.extension/eclipse from smila project folder

==== Building smila ====
The folder <tt>SMILA.builder</tt> contains everything needed to build SMILA and/or run all tests locally. 

Whether u build from command line or from eclipse, in both cases the <tt>make.xml</tt> ant script is executed. Before execution certain properties need to be set to meet the local setup.

# Independant of which way you are going to build, in both cases you must set the <tt>configs</tt> property in  the <tt>build.properties</tt> file to you setup. That is: 
#*Windows
#:<tt>
#:: configs=win32,win32,x86 
#:: # ...
#:</tt>
#*Linux
#:<tt>
#:: configs=linux,gtk,x86
#:: # ...
#:</tt>
#:Note: The default is to build for both, windows and linux platforms. However, for this to work locally the eclipse must have the corresponding plugins installed which is usually not the case if you downloaded a platform specific distribution. If platform plugins are missing you will end up on Windows with:
#:<tt>...
#:[java] D:\Program Files\eclipse33\eclipse-SDK-3.3.2-win32-smila-build\eclipse\plugins\org.eclipse.pde.build_3.3.2.v20071019\scripts\genericTargets.xml:85: Unable to find plug-in: org.eclipse.core.filesystem.linux.x86_0.0.0. Please check the error log for more details.</tt>


For the build from eclipse u pass in these values via the command line text box in the launch config on the command line these are set in a shell script.

===== Building SMILA from within eclipse =====
# select the SMILA.builder bundle
# open External Tools Dialog
# create a new ant build configuration or choose your configuration if exists
# choose the build file of this bundle, e. g. ${workspace_loc:/SMILA.builder/make.xml}
# insert the following arguments (but adapt these to your setup)
#: -DbuildDirectory=D:/eccenca/SMILA/eclipse.build 
#: -Declipse.home=D:/eclipse33 
#: -Dbuilder=D:/eccenca/SMILA/SMILA.builder 
#: -Declipse.running=true 
#: -DpdeBuildPluginVersion=3.3.2.v20071019
#: -DequinoxLauncherPluginVersion=1.0.1.R33x_v20080118
#: -Dos=win32 -Dws=win32 -Darch=x86
#: -Dtest.java.home=D:/java/jre1.5.0_11
# Apply, close and run SMILA.builder with this external tool configuration

===== Building SMILA from command line =====

The make.bat (or .sh) is just a shell script to set the properties that are needed for the ant script.

Steps:
# adjust all paths in \SMILA.builder\make.bat according to own setup
# execute make.bat

The whole process takes about 15 minutes at the time of writing, so be patient or get some java-like beverage ;)

=== run junit tests for osgi bundles ===
* Plugin Junit Launch config
* write config.ini and ref it from lauch config.
*:tip: use \ to brake up long lines to have better overview
* share the launch config
For further information see: [[SMILA/Development Guidelines|Development Guidelines]]