Skip to main content
Jump to: navigation, search

Difference between revisions of "Recommenders/BuildingFromSource"

m ("IRecommendersCompletionContextFactory already configured" when starting Recommenders in Eclipse runtime)
(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")
 
(13 intermediate revisions by 3 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 =
+
On your development machine, you should have installed/use:
+
 
+
* '''Eclipse 4.3+''':
+
** Plug-in Developer package (you need the ''plugin development environment'')
+
** Xtend 2.4+ Plug-ins (install from [http://marketplace.eclipse.org/content/eclipse-xtend Eclipse Marketplace])
+
* '''command line:'''
+
** Maven 3.0+
+
 
+
= Building with Maven Tycho  =
+
<pre>$ git clone http://git.eclipse.org/gitroot/recommenders/org.eclipse.recommenders.git
+
$ cd org.eclipse.recommenders
+
$ mvn clean install -P e43
+
</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/e43/
+
##Open ''''e43.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.
+
 
+
 
+
= Additional Notes =
+
After setting the target platform, there will be several projects projects which will still contain compile errors. '''*.fixture*''' projects contain test scenarios for code completion and don't compile "per construction". Some test and plug-in projects (e.g., codesearch.rcp, udc.rcp, and completion.rcp.templates) haven't been migrated to the latest e4.2 infrastructure yet. But you shouldn't care too much about them.
+
  
 
[[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