Skip to main content
Jump to: navigation, search

Difference between revisions of "Recommenders/BuildingFromSource"

m (Build Prerequisites)
(Replaced content with "See [https://git.eclipse.org/c/recommenders/org.eclipse.recommenders.git/about/ here] for a description how to build Code Recommenders from source. Category:Recommenders")
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__TOC__
+
See [https://git.eclipse.org/c/recommenders/org.eclipse.recommenders.git/about/ here] for a description how to build Code Recommenders from source.
 
+
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 [http://www.eclipse.org/downloads/packages/eclipse-ide-java-and-dsl-developers/keplerr Eclipse IDE for Java and DSL Developers]; it already contains all the required and recommended features for building our projects in the Eclipse IDE.
+
 
+
* Required features:
+
** [http://www.eclipse.org/jdt/ Eclipse Java Development Tools],
+
** [http://www.eclipse.org/pde/ Eclipse Plug-in Development Environment],
+
** and [http://www.eclipse.org/xtend/ Xtend]
+
* Recommended features:
+
** [http://www.eclipse.org/egit/ Eclipse Git Team Provider],
+
** [http://www.eclipse.org/m2e/ Maven Integration for Eclipse],
+
** [https://code.google.com/a/eclipselabs.org/p/workspacemechanic/ Workspace Mechanic],
+
** and the [http://www.eclipse.org/recommenders/ Code Recommenders Developer Tools], of course
+
 
+
If you want to build Eclipse Code Recommenders from the command line, you will need [http://maven.apache.org/download.html Apache Maven], version 3.x
+
 
+
= Building with Maven Tycho  =
+
<pre>$ 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
+
</pre>
+
 
+
= Building from Eclipse Workspace  =
+
 
+
Configuring Eclipse Code Recommenders Workspace for Eclipse is slightly more complicated:
+
 
+
On command line do:
+
<pre>$ git clone http://git.eclipse.org/gitroot/recommenders/org.eclipse.recommenders.git
+
</pre>
+
 
+
Then,
+
 
+
#Import all projects into your Eclipse workspace.
+
# Set workspace encoding to UTF-8.
+
# <font color=red>Set the workspace's target platform: </font>
+
##Go to /targets/kepler/
+
##Open ''''kepler.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 a few projects)
+
# 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 [http://wiki.eclipse.org/index.php/Execution_Environments this page] how to install and use EEDs.
+
#Done. Start a new Eclipse runtime via the product configuration file located under  /etc/eclipse/ide.product
+
#Remove API Baseline. If you want remove alle errors from the problems view, you have to disable the API Baseline: open the preferences, go to API Baselines and set "Missing API baseline" to ignore.
+
 
+
= 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.
+
 
+
 
+
  
 
[[Category:Recommenders]]
 
[[Category:Recommenders]]

Latest revision as of 07:00, 6 January 2014

See here for a description how to build Code Recommenders from source.

Back to the top