Jump to: navigation, search

Difference between revisions of "CDO Source Installation"

(Materialize the Sources and the Target Platform)
(37 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Introduction ==
+
This tutorial describes how to install a '''CDO workspace''' using [http://www.eclipse.org/buckminster/ Buckminster].<br>
This tutorial describes how to install the CDO workspace using [http://www.eclipse.org/buckminster/ Buckminster].<br>
+
The '''sources''' can also be browsed through [http://git.eclipse.org/c/cdo/cdo.git/tree http://git.eclipse.org/c/cdo/cdo.git/tree].<br>
The sources can also be browsed through the [http://git.eclipse.org/c/cdo/cdo.git/tree/ Git web interface].
+
'''Binaries''' can be installed or downloaded from [http://www.eclipse.org/cdo/downloads http://www.eclipse.org/cdo/downloads].
  
 
== Prepare the IDE ==
 
== Prepare the IDE ==
Download and install Eclipse 3.7 or 3.8 from [http://download.eclipse.org/eclipse/downloads/eclipse3x.php]
+
Download and install Eclipse 3.8 from [http://download.eclipse.org/eclipse/downloads/eclipse3x.php http://download.eclipse.org/eclipse/downloads/eclipse3x.php]
  
 
Then open a fresh development workspace.
 
Then open a fresh development workspace.
Line 11: Line 11:
  
  
Select the [http://download.eclipse.org/releases/indigo Indigo] (for 3.7) or [http://download.eclipse.org/releases/juno Juno] (for 3.8) p2 repository and install the following features:
+
Select the [http://download.eclipse.org/releases/juno Juno] (for 3.8) p2 repository and install the following features:
 
* '''EMF - Eclipse Modeling Framework SDK'''
 
* '''EMF - Eclipse Modeling Framework SDK'''
* '''Graphical Modeling Framework SDK''' (needed for CDO Dawn)
+
* '''Graphical Modeling Framework (GMF) Notation SDK''' (needed for CDO Dawn)
* '''Eclipse EGit''' (Team Provider)
+
* '''Graphical Modeling Framework (GMF) Runtime SDK''' (needed for CDO Dawn)
 +
* '''Eclipse EGit''' (we install newer versions from [http://download.eclipse.org/egit/updates-nightly http://download.eclipse.org/egit/updates-nightly])
  
Select the [http://download.eclipse.org/tools/buckminster/updates-3.7 Buckminster] p2 repository and install the following features:
+
Select the [http://download.eclipse.org/tools/buckminster/updates-4.2 Buckminster] p2 repository and install the following features:
 
* '''Buckminster - Core'''
 
* '''Buckminster - Core'''
 
* '''Buckminster - Git Support'''
 
* '''Buckminster - Git Support'''
 
* '''Buckminster - PDE Support'''
 
* '''Buckminster - PDE Support'''
 +
 +
'''Committers''': Please do not forget to install our versioning tool from [http://download.eclipse.org/modeling/emf/cdo/updates/integration http://download.eclipse.org/modeling/emf/cdo/updates/integration]:
 +
 +
[[Image:CDO_Versioning_Tool.png]]
  
 
Now you have prepared your IDE with the required tools.
 
Now you have prepared your IDE with the required tools.
Line 25: Line 30:
 
== Create the API Baseline ==
 
== Create the API Baseline ==
  
Now an API baseline will be created. Non-committers may skip this section.
+
Non-committers may skip this section, but should instead reduce the problem marker severity for "Missing API baseline" from Error to Warning or Ignore (see screenshot below)!
  
* Create a new workspace project called "_baseline"
+
[[Image:APIBaseline-4.1-Ignore.png]]
  
[[Image:Cdo_export_targetdef0.png]]
+
Download the 4.1 baseline from [https://sourceforge.net/projects/net4j/files/Baselines https://sourceforge.net/projects/net4j/files/Baselines] and extract it to your local disk.
  
* Download the 4.0 baseline from [https://sourceforge.net/projects/net4j/files/Baselines/ SourceForge] and extract it into the _baseline project.
+
Add the API baseline to Eclipse. Open the <i>Preferences</i> (Window->Preferences) and go to the "API Baselines" page:
  
* Now add the API baseline: Open the <i>Preferences</i> (Window->Preferences) and open the "API Baselines" page.
+
[[Image:APIBaseline-4.1.png]]
  
[[Image:Cdo_export_targetdef3.png]]
+
Click "Add Baseline...". Give it the name ''CDO 4.1 Baseline'' and choose the path to the folder on your local disk where you've extracted the downloaded baseline to:
  
* Click "Add Baseline...". Give it the name ''CDO 4.0 Baseline'' and choose the path to your ''_baseline'' project as destination. Then the API baseline is created and set active for your workspace.
+
[[Image:APIBaseline-4.1-Add.png]]
  
[[Image:Cdo_export_targetdef4.png]]
+
Now the API baseline is created and set active for your workspace:
  
== Materialize the Sources and the Target Platform ==
+
[[Image:APIBaseline-4.1-Finish.png]]
  
The materialization of the workspace contents (sources and binaries) will be performed by Buckminster with the cooperation of EGit and p2. For EGit to work properly please create the folder ${user.home}/git on your hard disk.
+
== Materialize the Sources and the Target Platform  ==
  
Then start the Buckminster import wizard:
+
The materialization of the workspace contents (sources and binaries) will be performed by Buckminster with the cooperation of EGit and p2.
  
[[Image:cdo_import1.png]]
+
'''Hint:''' The p2 materializer might require lots of memory, and you might experience OutOfMemory Java errors while loading and resolving the target platform. You then might want to make sure your eclipse is configured properly, for instance using (in ''eclipse.ini''):
 +
<pre>--launcher.XXMaxPermSize
 +
256M
 +
-vmargs
 +
-Xms512m
 +
-Xmx1024m
 +
-XX:PermSize=256M
  
Point it to the Buckminster MSpec of CDO: [http://git.eclipse.org/c/cdo/cdo.git/plain/plugins/org.eclipse.emf.cdo.releng/local.mspec]
+
</pre>
 +
'''For EGit to work properly please create the folder ${user.home}/git on your hard disk.''' (Alternatively you can start your eclipse instance with the following parameter: -Dgit.clone=D:/Development/git/cdo. Also set the default directory und Window-&gt;Preferences--&gt;Team--&gt;Git to "D:/Development/git)
  
[[Image:cdo_import2.png]]
+
Then start the Buckminster import wizard:  
  
Press the Load button and wait until Buckminster has resolved all the dependencies. Go and fetch a coffee, or two, or three...
+
[[Image:Cdo import1.png]]
  
[[Image:cdo_import3.png]]
+
Point it to the Buckminster MSpec of CDO: [http://git.eclipse.org/c/cdo/cdo.git/plain/plugins/org.eclipse.emf.cdo.releng/local.mspec http://git.eclipse.org/c/cdo/cdo.git/plain/plugins/org.eclipse.emf.cdo.releng/local.mspec].
  
Finally hit the 'Finish' button
+
For a 4.1 maintenance workspace use [http://git.eclipse.org/c/cdo/cdo.git/plain/plugins/org.eclipse.emf.cdo.releng/local.mspec?h=streams/4.1-maintenance http://git.eclipse.org/c/cdo/cdo.git/plain/releng/org.eclipse.emf.cdo.releng/local.mspec?h=streams/4.0-maintenance] instead. Please note: This does not work until Buckminster [https://bugs.eclipse.org/bugs/show_bug.cgi?id=368573 bug 368573] is resolved (please '''vote''' for the bug!). Instead clone the entire Git repository manually, checkout the maintenance branch, search the workspace for 'local.mspec' and import it by right-clicking and selecting Buckminster-&gt;Import...
  
[[Image:cdo_import4.png]]
+
[[Image:Cdo import2.png]]  
  
== Updating the Workspace ==
+
Press the Load button and wait until Buckminster has resolved all the dependencies (go and fetch a coffee, or two, or three).
  
You can update your development workspace by re-importing the local.mpec (right-click + Buckminster + Import...). Then the whole workspace and the target platform are updated.
+
[[Image:Cdo import3.png]]
  
Note, that re-importing doesn't update your source from the Git repository. Use EGit for this purpose!
+
When the dependencies have been resolved properly hit the 'Finish' button:
  
== Tooling (Developers only) ==
+
[[Image:Cdo import4.png]]
  
Please do not forget to install install our versioning tool from [http://download.eclipse.org/modeling/emf/cdo/updates/integration http://download.eclipse.org/modeling/emf/cdo/updates/integration].
+
Finally open the ''Preferences'' (Window-&gt;Preferences) and go to the "Target Platform" page. Edit the active target platform and remove the '''location''' (not the target platform definition as a whole!) that points to the running installation. Now you're done.
  
[[Image:CDO_Versioning_Tool.png]]
+
== Update the Workspace ==
 +
 
 +
You can update your development workspace by re-importing the local.mpec (right-click + Buckminster + Import...). Then the whole workspace and the target platform are updated.
 +
 
 +
Note, that re-importing does only '''add''' new source projects but doesn't update existing source projects from the Git repository. Use the 'Pull' command of EGit for this purpose!

Revision as of 05:01, 15 January 2013

This tutorial describes how to install a CDO workspace using Buckminster.
The sources can also be browsed through http://git.eclipse.org/c/cdo/cdo.git/tree.
Binaries can be installed or downloaded from http://www.eclipse.org/cdo/downloads.

Prepare the IDE

Download and install Eclipse 3.8 from http://download.eclipse.org/eclipse/downloads/eclipse3x.php

Then open a fresh development workspace.

Cdo source1.png


Select the Juno (for 3.8) p2 repository and install the following features:

  • EMF - Eclipse Modeling Framework SDK
  • Graphical Modeling Framework (GMF) Notation SDK (needed for CDO Dawn)
  • Graphical Modeling Framework (GMF) Runtime SDK (needed for CDO Dawn)
  • Eclipse EGit (we install newer versions from http://download.eclipse.org/egit/updates-nightly)

Select the Buckminster p2 repository and install the following features:

  • Buckminster - Core
  • Buckminster - Git Support
  • Buckminster - PDE Support

Committers: Please do not forget to install our versioning tool from http://download.eclipse.org/modeling/emf/cdo/updates/integration:

CDO Versioning Tool.png

Now you have prepared your IDE with the required tools.

Create the API Baseline

Non-committers may skip this section, but should instead reduce the problem marker severity for "Missing API baseline" from Error to Warning or Ignore (see screenshot below)!

APIBaseline-4.1-Ignore.png

Download the 4.1 baseline from https://sourceforge.net/projects/net4j/files/Baselines and extract it to your local disk.

Add the API baseline to Eclipse. Open the Preferences (Window->Preferences) and go to the "API Baselines" page:

APIBaseline-4.1.png

Click "Add Baseline...". Give it the name CDO 4.1 Baseline and choose the path to the folder on your local disk where you've extracted the downloaded baseline to:

APIBaseline-4.1-Add.png

Now the API baseline is created and set active for your workspace:

APIBaseline-4.1-Finish.png

Materialize the Sources and the Target Platform

The materialization of the workspace contents (sources and binaries) will be performed by Buckminster with the cooperation of EGit and p2.

Hint: The p2 materializer might require lots of memory, and you might experience OutOfMemory Java errors while loading and resolving the target platform. You then might want to make sure your eclipse is configured properly, for instance using (in eclipse.ini):

--launcher.XXMaxPermSize
256M
-vmargs
-Xms512m
-Xmx1024m
-XX:PermSize=256M

For EGit to work properly please create the folder ${user.home}/git on your hard disk. (Alternatively you can start your eclipse instance with the following parameter: -Dgit.clone=D:/Development/git/cdo. Also set the default directory und Window->Preferences-->Team-->Git to "D:/Development/git)

Then start the Buckminster import wizard:

Cdo import1.png

Point it to the Buckminster MSpec of CDO: http://git.eclipse.org/c/cdo/cdo.git/plain/plugins/org.eclipse.emf.cdo.releng/local.mspec.

For a 4.1 maintenance workspace use http://git.eclipse.org/c/cdo/cdo.git/plain/releng/org.eclipse.emf.cdo.releng/local.mspec?h=streams/4.0-maintenance instead. Please note: This does not work until Buckminster bug 368573 is resolved (please vote for the bug!). Instead clone the entire Git repository manually, checkout the maintenance branch, search the workspace for 'local.mspec' and import it by right-clicking and selecting Buckminster->Import...

Cdo import2.png

Press the Load button and wait until Buckminster has resolved all the dependencies (go and fetch a coffee, or two, or three).

Cdo import3.png

When the dependencies have been resolved properly hit the 'Finish' button:

Cdo import4.png

Finally open the Preferences (Window->Preferences) and go to the "Target Platform" page. Edit the active target platform and remove the location (not the target platform definition as a whole!) that points to the running installation. Now you're done.

Update the Workspace

You can update your development workspace by re-importing the local.mpec (right-click + Buckminster + Import...). Then the whole workspace and the target platform are updated.

Note, that re-importing does only add new source projects but doesn't update existing source projects from the Git repository. Use the 'Pull' command of EGit for this purpose!