Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "CDO Source Installation (CVS, deprecated)"

(Bootstrap)
(Introduction)
 
(80 intermediate revisions by 6 users not shown)
Line 1: Line 1:
'''(Includes Net4j Source installation)'''
+
== Introduction ==
<br>
+
This tutorial describes how to install the CDO workspace using [http://www.eclipse.org/buckminster/ Buckminster]. This deprecated version checks out the workspace projects from CVS. The new '''SVN''' version can be found [[CDO Source Installation|here]].
<br>
+
__TOC__
+
  
<br>
+
== Prepare the IDE ==
==Introduction==
+
Download and install Eclipse 3.6 from http://download.eclipse.org/eclipse/downloads
This page explains how to install an Eclipse workspace that is ready to be used to develop and build [[CDO]] and [[Net4j]] (subsequently subsumed as ''CDO workspace'').
+
  
The CDO workspace will be configured with a dedicated [[#Java Development Kit|JDK]], connected with a dedicated [[#Target Platform|target platform]] to be built against and associated with a dedicated [[#API Baseline|API Baseline]] to be checked for API compliance against.
+
Then open a fresh development workspace.
  
As a consequence of the usage of a dedicated target platform you're free to choose any version of Eclipse as your IDE, recent versions preferred. We are using latest I-builds of Eclipse and some tools like [http://www.eclipse.org/mylyn Mylyn].
+
[[Image:Cdo_install1.png]]
  
We are using a common development folder <tt>C:\develop</tt> on the local file system which is the parent folder of the IDE installation/extensions, the workspaces folder and the downloads folder. It looks like:<br>[[Image:DevelopFolder.png]]
 
  
With this new version of the setup instructions most of the complicated steps like downloading needed prerequisites, unzipping and copying them are automated by an Ant script (which is described in the [[#Bootstrap|bootstrap chapter]]. There are still the [[CDO Source Installation (deprecated)|deprecated manual CDO Source Installation]] instructions available for archive purposes.
+
Add the following plug-ins from the Helios p2 repository (http://download.eclipse.org/releases/helios)
  
The following instructions assume that you want to work on the HEAD development stream. You'll have to adjust the bootstrap steps to switch to another stream or version. It is further assumed that you have basic knowledge about [[JDT]] and [[PDE]].
+
Install the following:
 +
* EMF 2.6 SDK
 +
* Buckminster 3.6 Core
 +
* Buckminster 3.6 CVS Support
 +
* Buckminster 3.6 PDE Support
 +
* GMF 1.4 SDK
  
<br>
 
==Bootstrap==
 
* Create the host workspace folder <tt>C:\develop\ws\cdo</tt> in the file system
 
* Start your Eclipse IDE with <tt>C:\develop\bin\eclipse\eclipse.exe -data C:\develop\ws\cdo</tt>
 
* Switch to the ''Plug-in Development'' perspective
 
* Import your existing preferences (optional)
 
* Configure a JDK 1.5 of your choice on the ''Installed JREs'' preference page
 
* Download the [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.cdo/develop/setup/.bootstrap.psf?root=Modeling_Project&view=co bootstrap Team PSF] and store it somewhere in your file system (we use <tt>C:\develop\ws\cdo</tt>)
 
* Import the downloaded bootstrap Team PSF (ignoring potential warnings about "partial repository" bla bla):<br>[[Image:Bootstrap1.png]]<br><br>
 
* Now your CDO workspace should look like this:<br>[[Image:Bootstrap2.png]]<br><br>
 
<br>
 
  
==Target Platform==
+
[[Image:Cdo_install2.png]]
* In your Eclipse IDE open the ''Preferences'' dialog via the ''Window'' menu and go to the page ''Target Platforms''
+
* Enter the new target platform ''Location'' <tt>C:\develop\ws\cdo\metadata\.target</tt>:<br>[[Image:TargetPlatformPrefs.png]]<br><br>
+
* Press the ''Reload'' button (just to be sure)
+
* Finally verify the ''Plug-ins'' list and press the ''Ok'' button
+
  
<br>
+
[[Image:Cdo_install3.png]]
  
==API Baseline==
+
'''Hint:''' You may alternatively install from the buckminster update site (the helios update site did not work in my case). Add '''http://download.eclipse.org/tools/buckminster/updates-3.6''' to your update sites and select the required bundles.
* In your Eclipse IDE open the ''Preferences'' dialog via the ''Window'' menu and go to the page ''API Baselines'' and press the ''Add Baseline...'' button
+
* Enter the ''Name'' and ''Location'' information:<br>[[Image:NewBaseline.png]]<br><br>
+
* Verify the ''Plug-ins/bundles'' list and press the ''Finish'' button to return to the ''Preferences'' dialog:<br>[[Image:BaselinePrefs.png]]<br><br>
+
* Leave the ''Preferences'' dialog by pressing the ''Ok'' button
+
  
 +
Now you have prepared your IDE with the required tools.
  
<br>
+
== Create the Target Platform ==
==Source Checkout==
+
* Checkout '''all''' projects (Net4j and [[CDO]]) with one of the maintained Team Project Set files
+
** '''HEAD''': [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.cdo/develop/psf/pserver.psf?view=log&root=Modeling_Project&pathrev=HEAD pserver.psf] or [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.cdo/develop/psf/extssh.psf?view=log&root=Modeling_Project&pathrev=HEAD extssh.psf]
+
** '''R1_0_maintenance''' (for which you might need a different target platform!): [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.cdo/develop/psf/pserver.psf?view=log&root=Modeling_Project&pathrev=R1_0_maintenance pserver.psf] or [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.cdo/develop/psf/extssh.psf?view=log&root=Modeling_Project&pathrev=R1_0_maintenance extssh.psf]
+
  
 +
For the target platfrom first create an empty project called "_target".
  
<br>
+
[[Image:Cdo_install4.png]]
==3rd Party Stuff==
+
  
Download the Hibernate JARs and copy them into the <tt>org.eclipse.emf.cdo.server.hibernate.libraries</tt> bundle in the workspace. (This step will be handled similarly to the MySQL and Hsqldb driver jars in the near future)
 
  
 +
Now create an empty target definition that Buckminster later can fill with the needed plug-ins (Windows->Preferences->Plugin Development->Target Platform)
  
<br>
+
 
----
+
[[Image:Cdo_install5.png]]
Wikis: [[CDO]] | [[Net4j]] | [[EMF]] | [[Eclipse]]
+
 
 +
 
 +
Insert the name for the target platform.
 +
 
 +
[[Image:Cdo_install6.png]]
 +
 
 +
 +
 
 +
Click 'Add'.
 +
 
 +
[[Image:Cdo_install7.png]]
 +
 
 +
 
 +
 
 +
Add the directory location ${workspace_loc}/_target.
 +
 
 +
[[Image:Cdo_install8.png]]
 +
 
 +
 
 +
Activate the platform.
 +
 
 +
[[Image:Cdo_install9.png]]
 +
 
 +
== Create the API Baseline ==
 +
 
 +
Now we need to create an API baseline. First, create a new workspace project called "_baseline"
 +
 
 +
[[Image:Cdo_export_targetdef0.png]]
 +
 
 +
* Download a fresh [http://download.eclipse.org/eclipse/downloads/drops/R-3.6-201006080911/index.php Eclipse 3.6], extract and run it.
 +
* Install all features from [http://net4j.sourceforge.net/update/ http://net4j.sourceforge.net/update/].
 +
* Install all features from [http://download.eclipse.org/modeling/emf/cdo/updates/3.0-releases/ http://download.eclipse.org/modeling/emf/cdo/updates/3.0-releases/].
 +
* Copy or move the ''plugins/'' folder from the new Eclipse installation into the ''_baseline'' workspace project.
 +
* Delete the rest of the new Eclipse installation.
 +
 
 +
Now we must add the API baseline. Open the <i>Preferences</i> (Window->Preferences) and open the "API Baselines" page.
 +
 
 +
[[Image:Cdo_export_targetdef3.png]]
 +
 
 +
Click "Add Baseline...". Give it the name ''CDO 3.0 GA Baseline'' and choose the path to your ''_baseline'' project as destination. Then the API baseline is created and set active for your workspace.
 +
 
 +
[[Image:Cdo_export_targetdef4.png]]
 +
 
 +
== Bootstrap the Releng Project ==
 +
 
 +
Now you need to bootstrap the releng project.
 +
 
 +
http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.cdo/releng/org.eclipse.emf.cdo.releng/psf/pserver/_bootstrap.psf?root=Modeling_Project&view=co
 +
 
 +
Committers use:
 +
http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.cdo/releng/org.eclipse.emf.cdo.releng/psf/extssh/_bootstrap.psf?root=Modeling_Project&view=co
 +
 
 +
Right click the Package Explorer and choose Imort->Team Project Set. Select the downloaded _bootstrap.psf
 +
 
 +
[[Image:Cdo_install10.png]]
 +
 
 +
[[Image:Cdo_install11.png]]
 +
 
 +
[[Image:Cdo_install12.png]]
 +
 +
 
 +
 
 +
Note, if you want to work on CDO 3.0 switch the branch with Team|Switch to "R3_0_maintenance" branch (not tag!)
 +
 
 +
== Materialize the Sources and the Target Platform ==
 +
 
 +
To materialize the sources right-click the local.mspec, select Buckminster|Import...
 +
 
 +
[[Image:Cdo_install15.png]]
 +
 
 +
While the following dialog is running go and fetch a coffee, or two, or three...
 +
 
 +
 
 +
[[Image:Cdo_install16.png]]
 +
 
 +
Finally hit the 'Finish' button
 +
 
 +
[[Image:Cdo_install14.png]]
 +
 
 +
== Updating the Workspace ==
 +
 
 +
You can update your development workspace with re-importing the local.mpec as described above. Then the whole workspace and the target platform are updated.
 +
 
 +
Note, that re-importing doesn't update your source from CVS repository.

Latest revision as of 14:56, 18 January 2011

Introduction

This tutorial describes how to install the CDO workspace using Buckminster. This deprecated version checks out the workspace projects from CVS. The new SVN version can be found here.

Prepare the IDE

Download and install Eclipse 3.6 from http://download.eclipse.org/eclipse/downloads

Then open a fresh development workspace.

Cdo install1.png


Add the following plug-ins from the Helios p2 repository (http://download.eclipse.org/releases/helios)

Install the following:

  • EMF 2.6 SDK
  • Buckminster 3.6 Core
  • Buckminster 3.6 CVS Support
  • Buckminster 3.6 PDE Support
  • GMF 1.4 SDK


Cdo install2.png

Cdo install3.png

Hint: You may alternatively install from the buckminster update site (the helios update site did not work in my case). Add http://download.eclipse.org/tools/buckminster/updates-3.6 to your update sites and select the required bundles.

Now you have prepared your IDE with the required tools.

Create the Target Platform

For the target platfrom first create an empty project called "_target".

Cdo install4.png


Now create an empty target definition that Buckminster later can fill with the needed plug-ins (Windows->Preferences->Plugin Development->Target Platform)


Cdo install5.png


Insert the name for the target platform.

Cdo install6.png


Click 'Add'.

Cdo install7.png


Add the directory location ${workspace_loc}/_target.

Cdo install8.png


Activate the platform.

Cdo install9.png

Create the API Baseline

Now we need to create an API baseline. First, create a new workspace project called "_baseline"

Cdo export targetdef0.png

Now we must add the API baseline. Open the Preferences (Window->Preferences) and open the "API Baselines" page.

Cdo export targetdef3.png

Click "Add Baseline...". Give it the name CDO 3.0 GA Baseline and choose the path to your _baseline project as destination. Then the API baseline is created and set active for your workspace.

Cdo export targetdef4.png

Bootstrap the Releng Project

Now you need to bootstrap the releng project.

http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.cdo/releng/org.eclipse.emf.cdo.releng/psf/pserver/_bootstrap.psf?root=Modeling_Project&view=co

Committers use: http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.cdo/releng/org.eclipse.emf.cdo.releng/psf/extssh/_bootstrap.psf?root=Modeling_Project&view=co

Right click the Package Explorer and choose Imort->Team Project Set. Select the downloaded _bootstrap.psf

Cdo install10.png

Cdo install11.png

Cdo install12.png


Note, if you want to work on CDO 3.0 switch the branch with Team|Switch to "R3_0_maintenance" branch (not tag!)

Materialize the Sources and the Target Platform

To materialize the sources right-click the local.mspec, select Buckminster|Import...

Cdo install15.png

While the following dialog is running go and fetch a coffee, or two, or three...


Cdo install16.png

Finally hit the 'Finish' button

Cdo install14.png

Updating the Workspace

You can update your development workspace with re-importing the local.mpec as described above. Then the whole workspace and the target platform are updated.

Note, that re-importing doesn't update your source from CVS repository.

Back to the top