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"

(Create the API Baseline)
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This tutorial describes how to install a '''CDO workspace''' using [http://www.eclipse.org/buckminster/ Buckminster].<br>
+
To provision the same development environment that the CDO developers use follow these simple steps:
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>
+
'''Binaries''' can be downloaded from [http://www.eclipse.org/cdo/downloads http://www.eclipse.org/cdo/downloads].
+
  
== Prepare the IDE ==
+
# Download and start the [[Eclipse Installer]].
Download and install Eclipse 3.7 or 3.8 from [http://download.eclipse.org/eclipse/downloads/eclipse3x.php http://download.eclipse.org/eclipse/downloads/eclipse3x.php]
+
# Drag [https://git.eclipse.org/c/cdo/cdo.git/plain/releng/org.eclipse.emf.cdo.releng/CDOConfiguration.setup this link] and drop it on the installer's title area. Alternatively, copy the location of the previous link and apply it to the Eclipse Installer either via the menu in the upper right in simple mode or via the left-most toolbar button to the upper right in advanced mode.
 +
# Review and/or edit the variable values that the installer presents.
 +
# Click the Next/Finish buttons until the installation starts.
  
Then open a fresh development workspace.
 
  
[[Image:Cdo_source1.png]]
+
You can update your development workspace by pulling the latest updates into your CDO Git clone and selecting the '''Perform Setup Tasks...''' action in the '''Help''' menu.
 
+
 
+
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:
+
* '''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''' (Team Provider)
+
 
+
Select the [http://download.eclipse.org/tools/buckminster/updates-3.7 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 http://download.eclipse.org/modeling/emf/cdo/updates/integration]:
+
 
+
[[Image: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)!
+
 
+
Download the 4.0 baseline from [https://sourceforge.net/projects/net4j/files/Baselines https://sourceforge.net/projects/net4j/files/Baselines] and extract it to your local disk.
+
 
+
Add the API baseline to Eclipse. Open the <i>Preferences</i> (Window->Preferences) and go to the "API Baselines" page:
+
 
+
[[Image:Cdo_baseline1.png]]
+
 
+
Click "Add Baseline...". Give it the name ''CDO 4.0 Baseline'' and choose the path to the folder on your local disk where you've extracted the downloaded baseline to:
+
 
+
[[Image:Cdo_baseline2.png]]
+
 
+
Now the API baseline is created and set active for your workspace:
+
 
+
[[Image:Cdo_baseline3.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.
+
 
+
'''For EGit to work properly please create the folder ${user.home}/git on your hard disk.'''
+
 
+
Then start the Buckminster import wizard:
+
 
+
[[Image: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 http://git.eclipse.org/c/cdo/cdo.git/plain/plugins/org.eclipse.emf.cdo.releng/local.mspec].
+
 
+
For a 4.0 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 http://git.eclipse.org/c/cdo/cdo.git/plain/releng/org.eclipse.emf.cdo.releng/local.mspec?h=streams/4.0-maintenance] instead.
+
 
+
[[Image: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).
+
 
+
[[Image:cdo_import3.png]]
+
 
+
Finally hit the 'Finish' button
+
 
+
[[Image:cdo_import4.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 EGit for this purpose!
+

Revision as of 06:08, 2 February 2018

To provision the same development environment that the CDO developers use follow these simple steps:

  1. Download and start the Eclipse Installer.
  2. Drag this link and drop it on the installer's title area. Alternatively, copy the location of the previous link and apply it to the Eclipse Installer either via the menu in the upper right in simple mode or via the left-most toolbar button to the upper right in advanced mode.
  3. Review and/or edit the variable values that the installer presents.
  4. Click the Next/Finish buttons until the installation starts.


You can update your development workspace by pulling the latest updates into your CDO Git clone and selecting the Perform Setup Tasks... action in the Help menu.

Back to the top