Skip to main content
Jump to: navigation, search

Difference between revisions of "Recommenders/BuildingFromSource"

Line 1: Line 1:
__TOC__
+
__TOC__  
  
Building Eclipse Code Recommenders from sources should be pretty easy. If some of the steps below fail - let us know.
+
Building Eclipse Code Recommenders from sources should be pretty easy. If some of the steps below fail - let us know.  
  
= Building with Maven '''without''' coverage tests =
+
= Building with Tycho  =
 +
<pre>$ git clone http://git.eclipse.org/gitroot/recommenders/org.eclipse.recommenders.git
 +
$ cd org.eclipse.recommenders
 +
$ mvn clean install
 +
</pre>
 +
''mvn clean install'' automatically executes the maven builds for Eclipse 4.2 platform. If you want to build Code Recommenders for 3.7 just use
 +
<pre>$ mvn clean install -P e3x
 +
</pre>
 +
= Building from Eclipse Workspace  =
  
# Clone code recommenders git repository.
+
Configuring Eclipse Code Recommenders Workspace for Eclipse is slightly more complicated:
# Run 'mvn clean install'.
+
  
= Building with Maven including coverage tests =
+
On command line do:
 +
<pre>$ git clone http://git.eclipse.org/gitroot/recommenders/org.eclipse.recommenders.git
 +
$ cd org.eclipse.recommenders
 +
$ mvn clean install
 +
</pre>
 +
This is currently required ''once'' to download the models archive for override completion.
  
# To run coverage tests you have to install Emma for measuring test coverage with maven. For a detailed description how to set up emma locally follow [https://docs.sonatype.org/display/TYCHO/How+to+integrate+EMMA+(code+coverage)+with+Tycho this guide].
+
Then,
# After installation run  'mvn clean install -P coverage'.
+
  
= Building from Eclipse Workspace =
+
#Import all projects into your Eclipse workspace.
Configuring Eclipse Code Recommenders Workspace for Eclipse is slightly more complicated:
+
#Set the workspace's target platform.
 +
##Go to etc/targets/
 +
##Open 'e37.target' target definition with target platform editor. For developing for Eclipse 4.2 just use e42.target instead.
 +
##Wait until Eclipse resolved all dependencies. Check the progress view to see when resolving finished.
 +
##Now click on the 'Set as target platform' link on the upper right corner of the editor.
 +
#Wait until workspace is rebuild and all compile errors went away (maybe except from a few projects)
 +
#Done. Start a new Eclipse runtime and trigger code completion on some Eclipse UI classes. The screenshot below gives a feature-based runtime configuration for Eclipse 3.7. Use that as starting point for your own configuration.
  
# Clone code recommenders git repository.
+
[[Image:Recommenders_example_runtime_configuration.png|Example Confoguration w/ Eclipse 3.7]]
# Run 'mvn clean install' once from the git repository root directory ('''required''': downloads model.zips for overrides and calls recommender).
+
# Import all projects into your Eclipse workspace.
+
# Set the workspace's target platform.
+
## Go to org.eclipse.recommenders.releng
+
## Open 'devel-3.6.target' target definition with target platform editor
+
## Wait until Eclipse resolved all dependencies. Check the progress view to see when resolving finished.
+
## Now click on the 'Set as target platform' link on the upper right corner of the editor.
+
# Wait until workspace is rebuild and all compile errors went away (maybe except from the testdata project)
+
# Done. Start your Eclipse runtime and trigger code completion on some Eclipse UI classes.
+
  
  
= Trouble with Building Code Recommenders? =
+
 
'''Please let us know!''' Point your browser to http://eclipse.org/forums/eclipse.recommenders and drop us a few lines there.
+
= Trouble with Building Code Recommenders? =
 +
 
 +
'''Please let us know!''' Point your browser to http://eclipse.org/forums/eclipse.recommenders and drop us a few lines there.  
  
 
[[Category:Recommenders|Building From Sources]]
 
[[Category:Recommenders|Building From Sources]]

Revision as of 13:55, 15 January 2012

Building Eclipse Code Recommenders from sources should be pretty easy. If some of the steps below fail - let us know.

Building with Tycho

$ git clone http://git.eclipse.org/gitroot/recommenders/org.eclipse.recommenders.git
$ cd org.eclipse.recommenders
$ mvn clean install

mvn clean install automatically executes the maven builds for Eclipse 4.2 platform. If you want to build Code Recommenders for 3.7 just use

$ mvn clean install -P e3x

Building from Eclipse Workspace

Configuring Eclipse Code Recommenders Workspace for Eclipse is slightly more complicated:

On command line do:

$ git clone http://git.eclipse.org/gitroot/recommenders/org.eclipse.recommenders.git
$ cd org.eclipse.recommenders
$ mvn clean install

This is currently required once to download the models archive for override completion.

Then,

  1. Import all projects into your Eclipse workspace.
  2. Set the workspace's target platform.
    1. Go to etc/targets/
    2. Open 'e37.target' target definition with target platform editor. For developing for Eclipse 4.2 just use e42.target instead.
    3. Wait until Eclipse resolved all dependencies. Check the progress view to see when resolving finished.
    4. Now click on the 'Set as target platform' link on the upper right corner of the editor.
  3. Wait until workspace is rebuild and all compile errors went away (maybe except from a few projects)
  4. Done. Start a new Eclipse runtime and trigger code completion on some Eclipse UI classes. The screenshot below gives a feature-based runtime configuration for Eclipse 3.7. Use that as starting point for your own configuration.

Example Confoguration w/ Eclipse 3.7


Trouble with Building Code Recommenders?

Please let us know! Point your browser to http://eclipse.org/forums/eclipse.recommenders and drop us a few lines there.

Copyright © Eclipse Foundation, Inc. All Rights Reserved.