Recommenders/BuildingFromSource

From Eclipsepedia

Jump to: navigation, search

Contents


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

Build Prerequisites

If you want to contribute to Eclipse Code Recommenders, we recommend the latest Eclipse IDE for Java and DSL Developers; it already contains all the required and recommended features for building our projects in the Eclipse IDE.

If you want to build Eclipse Code Recommenders from the command line, you will need Apache Maven, version 3.x

Building with Maven Tycho

$ git clone http://git.eclipse.org/gitroot/recommenders/org.eclipse.recommenders.git
$ cd org.eclipse.recommenders
$ export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m"
$ mvn clean install

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

Then,

  1. Install Workspace Mechanic. Then go to Preferences > Workspace Mechanic > Task Sources and add the folder "/$RECOMMENDERS_GIT_REPO/tools/mechanic">.
  2. Import all projects into your Eclipse workspace. Use the Import existing Maven Projects WIzard. Otherwise you will only found a couple of test projects.
  3. Set the workspace's target platform:
    1. Go to /targets/kepler/
    2. Open 'kepler.target' target definition with target platform editor.
    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.
  4. Wait until workspace is rebuild and all compile errors went away (maybe except from a few projects)
  5. In the case you see error markers on the projects saying Execution environment references were not checked for 'project-name' because no environment descriptions are installed. your Eclipse installation is missing an Execution Environment Description (EED) for Java 1.6. See this page how to install and use EEDs.
  6. Done. Start a new Eclipse runtime via the product configuration file located under /etc/eclipse/ide.product

Troubleshooting

If anything does not work as expected, report it to http://eclipse.org/forums/eclipse.recommenders. We are glad to lend a hand to get the build working for you.


For Extenders of Code Recommenders

First, an extender is someone who adds new plug-ins to code recommenders that may or may not use (but not manipulate) existing code of Code Recommenders. In order to reuse our code base, there is a special target platform that contains all dependencies as well as all bundles from the head/e42 update site. The file can be found in etc/targets/e42-extender.target.

To use this target platform definition, just load the target file (via "Open External File"), and set the target platform by clicking on the link on the upper right. There should be no need to import any of code recommenders plug-ins in your workspace.