One time setup instructions for working with Apache UIMA source code

Here you will find information on how to set up various tools used in working with Apache UIMA™ source code, including:

Java - use a 1.5 JVM or later.

SVN

Maven

Eclipse

One time setup for SVN

Install an svn client (not server) to use for command line invocation of SVN from https://subversion.apache.org/packages.html. Use the 1.6.x or later version. For Windows platform, you may find it convenient to also install a windows shell extension for this, such as the one from Tigris.org.

If you are using an IDE, you should obtain the SVN client for that IDE.

See svn.html for further details about accessing the source, including accommodating firewalls.

Important:

Configure your SVN client to set the eol-style to native, for newly created files; see https://apache.org/dev/svn-eol-style.txt for instructions on how to do this.

One time setup for Maven

Download Maven 3.0 or later from https://maven.apache.org/download.html.

Set up your path to use this version.
(Optional, but is needed for some JVM/platforms, to give the JVM enough room to build things). Add the following environment variable for Maven:
  Variable name: MAVEN_OPTS

  Value: -Xmx800m  -XX:MaxPermSize=256m

One time setup for Eclipse

Install Eclipse version 3.7.2 or later.

Then:

Install the SVN support plugin Subclipse from https://subclipse.tigris.org/. Be sure to pick the version for 1.6.x or the 1.8.x SVN client. Either of these work with the Apache SVN, but you cannot mix them - pick one and stick with it for all your SVN access (e.g., Eclipse, commandline, TortiseSVN Windows shell extensions, etc.)

Install m2e (latest recommended version) from the Eclipse update site: https://www.eclipse.org/m2e/.

When checking out UIMA modules, one method known to work (others may be added) is to do the initial check-out using the SVN command "svn checkout https://svn.apache.org/repos/asf/uima/uimaj/trunk some-local-directory" (This is just an example - you may need to check out different parts, branches, etc., please adjust the command as needed). Then use the Eclipse menu File -> Import -> Import existing Maven projects and navigate to the directory where you checked out the projects. The plugin will analyze what's there, and then offer to import all the projects. You can just go ahead, or select some subset to import into Eclipse.

You will likely (the first time) get some messages from m2e about missing connectors - and the offer from m2e to have it search for them - you should permit this and it will then find and download and install (with your permission) the connectors it needs to do the m2e build of the Maven projects.

(Optional - if you are using m2e plugin to run Maven build commands.) Use Eclipse Preferences -> Java -> Installed JREs and select the JRE you will be using as the default, and click "Edit" and add the default VM arguments from MAVEN_OPTS above.