org.eclipse.egit.doc/help/EGit/Contributor_Guide/Development-IDE-Configuration.html

   1 <?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3         <head>
   4                 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
   5                 <title>EGit Contributor Guide - Development IDE Configuration</title>
   6                 <link type="text/css" rel="stylesheet" href="../../book.css"/>
   7         </head>
   8         <body>
   9                 <table class="navigation" style="width: 100%;" border="0" summary="navigation">
  10                         <tr>
  11                                 <th style="width: 100%" align="center" colspan="3">Development IDE Configuration</th>
  12                         </tr>
  13                         <tr>
  14                                 <td style="width: 20%" align="left">
  15                                         <a href="Obtaining-Sources.html" title="Obtaining Sources">
  16                                                 <img alt="Previous" border="0" src="../../images/prev.gif"/>
  17                                         </a>
  18                                 </td>
  19                                 <td style="width: 60%" align="center"></td>
  20                                 <td style="width: 20%" align="right">
  21                                         <a href="Builds.html" title="Builds">
  22                                                 <img alt="Next" border="0" src="../../images/next.gif"/>
  23                                         </a>
  24                                 </td>
  25                         </tr>
  26                         <tr>
  27                                 <td style="width: 20%" align="left" valign="top">Obtaining Sources</td>
  28                                 <td style="width: 60%" align="center"></td>
  29                                 <td style="width: 20%" align="right" valign="top">Builds</td>
  30                         </tr>
  31                 </table><hr class="navigation-separator"/>
  32                 <h1 id="Development_IDE_Configuration">Development IDE Configuration</h1>
  33                 <p>Download and install the Eclipse package "Eclipse IDE for Eclipse Committers" or "Eclipse for RCP and RAP Developers" from here, if you don't already have it:</p>
  34                 <p>
  35                         <a href="http://www.eclipse.org/downloads/" target="egit_external">http://www.eclipse.org/downloads/</a>
  36                 </p>
  37                 <h2 id="Tools">Tools</h2>
  38                 <p>
  39                         <b>Note:</b> You have to use at least Eclipse 4.3.2 (Kepler SR2), earlier versions had a bug where the following did not work (see
  40                         <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=409073" target="egit_external">bug 409073</a>).
  41                 </p>
  42                 <p>To install all the necessary tools to work on EGit/JGit, there is a
  43                         <a href="http://git.eclipse.org/c/egit/egit.git/plain/tools/egit-developer-tools.p2f" target="egit_external">egit-developer-tools.p2f</a> file which you can use as follows:
  44                 </p>
  45                 <ul>
  46                         <li>File &gt; Import &gt; Install &gt; Install Software Items from File</li>
  47                         <li>Browse...
  48                                 <ul>
  49                                         <li>Go to the location of your egit repository, open the
  50                                                 <i>tools</i> directory and select
  51                                                 <i>egit-developer-tools.p2f</i>
  52                                         </li>
  53                                         <li>Alternatively, if you only want to contribute to JGit, download the file from the above link and select it</li>
  54                                 </ul>
  55                         </li>
  56                         <li>All the items you don't already have should be selected automatically</li>
  57                         <li>Finish the wizard</li>
  58                         <li>Restart</li>
  59                 </ul>
  60                 <h2 id="Java_Requirements">Java Requirements</h2>
  61                 <p>EGit and JGit have Java 7.0 and
  62                         <a href="https://wiki.eclipse.org/EGit/FAQ#What_versions_of_Eclipse_does_EGit_target.3F" target="egit_external">Eclipse Platform 3.8.2 (Juno)</a> as minimum requirements, so dependencies to newer Java and platform versions must be avoided.
  63                 </p>
  64                 <p>We are using
  65                         <i>API Tools Environment Descriptions</i> (see changes for
  66                         <a href="https://git.eclipse.org/r/#/c/4785/" target="egit_external">JGit</a> and
  67                         <a href="https://git.eclipse.org/r/#/c/4365/" target="egit_external">EGit</a>) to facilitate detecting code which isn't working on Java 7. If you followed the instructions in the
  68                         <i>Tools</i> section above, the necessary descriptions should already be installed. Otherwise install
  69                         <i>API Tools Environment Descriptions</i> from the release train repository, see
  70                         <a href="http://wiki.eclipse.org/Execution_Environments#Installing_Execution_Environment_Descriptions" title="Execution_Environments#Installing_Execution_Environment_Descriptions" target="egit_external">Installing Execution Environment Descriptions</a>.
  71                 </p>
  72                 <h2 id="Dependencies">Dependencies</h2>
  73                 <p>After importing the EGit and JGit projects in Eclipse, they will not compile due to missing dependencies. There are a few ways to install these.</p>
  74                 <h3 id="Option_1_.28recommended.29:_Use_a_Target_Platform">Option 1 (recommended): Use a Target Platform</h3>
  75                 <p>
  76                         <img align="right" title="EGit target platforms in org.eclipse.egit.target" alt="EGit target platforms in org.eclipse.egit.target" border="0" src="images/EGit-Target-Platforms.png‎"/>
  77                 </p>
  78                 <p>This is the easiest method to install dependencies:</p>
  79                 <ul>
  80                         <li>Open the
  81                                 <i>org.eclipse.egit.target</i> project
  82                         </li>
  83                         <li>Choose the
  84                                 <i>egit-&lt;version&gt;.target</i> file matching the version of your Eclipse platform (e.g. 4.5 for Mars) and open it (this may take a while as it downloads the indexes of the p2 repositories the target platform refers to)
  85                         </li>
  86                         <li>In the resulting editor, click on the
  87                                 <i>Set as Target Platform</i> link at the top right (this may also take a while since it downloads the dependencies)
  88                         </li>
  89                 </ul>
  90                 <p>After that, the workspace should build cleanly. If not, try Project &gt; Clean... &gt; All. If this also doesn't help open Preferences &gt; Plug-In Development &gt; Target Platform,
  91                         select the checked target platform and click "Reload..." this will flush PDE's bundle cache and re-download the artifacts listed in the target platform.</p>
  92                 <p>There are different target definitions, one for each version of Eclipse that EGit supports. The one you select will be the one that is started if you want to try out a feature or bug fix.</p>
  93                 <p>You can always switch between them to test on different Eclipse versions. E.g. when you are developing some major UI functionality, you should try it with the oldest supported Eclipse release to make sure it doesn't depend on API that is only available in later versions.</p>
  94                 <h3 id="Option_2:_Install_from_Orbit_P2_Repository">Option 2: Install from Orbit P2 Repository</h3>
  95                 <p>Install the dependencies from the Orbit p2 repository by importing the p2f file described
  96                         <a href="#Tools">above</a>.
  97                 </p>
  98                 <p>If you want to try another Orbit p2 repository version on the
  99                         <a href="https://download.eclipse.org/tools/orbit/downloads/" target="egit_external">Orbit Downloads</a> page, click on the newest recommended build (R-Build) and copy the update site link from "Orbit Build Repository" (it should end with <tt>/repository</tt>). Add this update site in Eclipse using "Install New Software..." and then find and select the following entries:
 100                 </p>
 101                 <ul>
 102                         <li>Java Mocking and Stubbing Framework</li>
 103                         <li>Args4j</li>
 104                         <li>Protocol Buffers</li>
 105                         <li>Apache Jakarta log4j Plug-in</li>
 106                         <li>Apache Commons Compress</li>
 107                         <li>XZ Data Compression</li>
 108                         <li>Hamcrest Library of Matchers</li>
 109                         <li>JavaEWAH</li>
 110                 </ul>
 111                 <h2 id="Running">Running</h2>
 112                 <p>Now that everything builds, the next step is to run an Eclipse instance with the EGit/JGit code of the workspace:</p>
 113                 <ul>
 114                         <li>Right click on the
 115                                 <i>org.eclipse.egit.ui</i> project
 116                         </li>
 117                         <li>Debug As &gt; Eclipse Application</li>
 118                 </ul>
 119                 <p>This should create a new launch configuration and start a new nested Eclipse instance in debug mode. The created launch configuration can be edited, e.g. to change where the workspace of the nested Eclipse should be located.</p>
 120                 <p>The launch configuration can also be used in normal (non-debug) mode of course.</p>
 121                 <p>Also see the
 122                         <a href="http://help.eclipse.org/juno/topic/org.eclipse.pde.doc.user/guide/tools/launchers/eclipse_application_launcher.htm" target="egit_external">reference on eclipse application launchers</a>.
 123                 </p>
 124                 <p>
 125                         <br/>
 126                 </p><hr class="navigation-separator"/>
 127                 <table class="navigation" style="width: 100%;" border="0" summary="navigation">
 128                         <tr>
 129                                 <td style="width: 20%" align="left">
 130                                         <a href="Obtaining-Sources.html" title="Obtaining Sources">
 131                                                 <img alt="Previous" border="0" src="../../images/prev.gif"/>
 132                                         </a>
 133                                 </td>
 134                                 <td style="width: 60%" align="center">
 135                                         <a href="Contributor-Guide.html" title="EGit Contributor Guide">
 136                                                 <img alt="EGit Contributor Guide" border="0" src="../../images/home.gif"/>
 137                                         </a>
 138                                 </td>
 139                                 <td style="width: 20%" align="right">
 140                                         <a href="Builds.html" title="Builds">
 141                                                 <img alt="Next" border="0" src="../../images/next.gif"/>
 142                                         </a>
 143                                 </td>
 144                         </tr>
 145                         <tr>
 146                                 <td style="width: 20%" align="left" valign="top">Obtaining Sources</td>
 147                                 <td style="width: 60%" align="center"></td>
 148                                 <td style="width: 20%" align="right" valign="top">Builds</td>
 149                         </tr>
 150                 </table>
 151         </body>
 152 </html>