You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2009/10/13 04:28:17 UTC
svn commit: r824572 - in /incubator/uima/site/trunk/uima-website:
docs/distribution.html docs/release.html docs/svn.html
xdocs/distribution.xml xdocs/release.xml xdocs/svn.xml
Author: schor
Date: Tue Oct 13 02:28:16 2009
New Revision: 824572
URL: http://svn.apache.org/viewvc?rev=824572&view=rev
Log:
UIMA-1613 update website to reflect changes in the build and release processes.
Modified:
incubator/uima/site/trunk/uima-website/docs/distribution.html
incubator/uima/site/trunk/uima-website/docs/release.html
incubator/uima/site/trunk/uima-website/docs/svn.html
incubator/uima/site/trunk/uima-website/xdocs/distribution.xml
incubator/uima/site/trunk/uima-website/xdocs/release.xml
incubator/uima/site/trunk/uima-website/xdocs/svn.xml
Modified: incubator/uima/site/trunk/uima-website/docs/distribution.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/distribution.html?rev=824572&r1=824571&r2=824572&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/distribution.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/distribution.html Tue Oct 13 02:28:16 2009
@@ -163,12 +163,14 @@
<blockquote class="sectionBody">
<p>
<ul>
- <li><a href="#Building the Apache UIMA core distribution">Building the Apache UIMA core distribution</a></li>
+ <li><a href="#Building the Apache UIMA base distribution">Building the Apache UIMA base distribution</a></li>
+ <li><a href="#Building the Apache UIMA-AS distribution">Building the Apache UIMA-AS distribution</a></li>
<li><a href="#Building Apache UIMA Sandbox distributions">Building Apache UIMA Sandbox distributions</a>
<ul>
<li><a href="#Building AnnotatorPackage distribution">Building AnnotatorPackage distribution</a></li>
</ul>
</li>
+ <li><a href="#Building the Eclipse Update Site">Building the Eclipse Update Site</a></li>
<li><a href="#Signing a distribution">Signing a distribution</a>
<ul>
<li><a href="#Getting started with release signing">Getting started with release signing</a></li>
@@ -185,89 +187,43 @@
<div class="sectionTable">
<table class="sectionTable">
<tr><td>
- <a name="Building the Apache UIMA core distribution"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Building the Apache UIMA core distribution</h1></a>
+ <a name="Building the Apache UIMA base distribution"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Building the Apache UIMA base distribution</h1></a>
</td></tr>
<tr><td>
<blockquote class="sectionBody">
<p>
- To build a distribution, you will need to set up your Maven development environment as described
- on the <a href="./svn.html">source code page</a>. Try extracting and building the code manually
- as described there. Once you have all that working, you can build a distribution with the help
+ Start by extracting and building the code manually as described on the
+ <a href="./svn.html">source code page</a>.
+ Once you have all that working, you can build a distribution with the help
of the scripts in <code>uimaj-distr/src/main/build</code>. Start out in an empty directory and
- run: <blockquote> <code>extractAndBuild.sh</code> </blockquote>
+ run: <blockquote> <code>extractAndBuild.bat</code>
+ from the uimaj-distr/src/main/build directory.</blockquote>
This will extract the source code from SVN, compile and run the tests, and finally build the
- distribution artifacts.
- </p>
- <p>The build process for base UIMA builds individual Jar files suitable for uploading into a maven repository, 2 assemblies
- (one for the source and one for the binary distributions), and an Eclipse update site. The
+ distribution artifacts. (It will not build the
+ <a href="#Building the Eclipse Update Site">Eclipse Update Site</a>).
+ </p>
+ <p>Note: to get the PDFs built, you have to run this on a Windows machine.</p>
+ <p>The build process for base UIMA builds individual Jar files suitable for uploading into a maven repository,
+ and 2 assemblies
+ (one for the source and one for the binary distributions). The
individual Jar files are in the <code>target</code> directories of the individual projects they
belong to. The assemblies (source and binary) are in the <code>uimaj-distr/target</code> directory.
</p>
- <p>
- The build process for UIMA-AS and the Sandbox projects is similar. Both have assembly projects:
- uima-as-distr and SandboxDistr.
- </p>
- <table class="subsectionTable">
+ </blockquote>
+ </p>
+ </td></tr>
+ </table>
+ <div class="sectionTable">
+ <table class="sectionTable">
<tr><td>
-
-
-
- <a name="Eclipse Update Site">
- <h2>Eclipse Update Site
- </h2>
- </a>
+ <a name="Building the Apache UIMA-AS distribution"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Building the Apache UIMA-AS distribution</h1></a>
</td></tr>
<tr><td>
- <blockquote class="subsectionBody">
+ <blockquote class="sectionBody">
<p>
- The Eclipse update site build is somewhat unusual, because it accumulates releases over time
- from various UIMA distributions. This is because we have just one update site (at the moment)
- for all releases, for all components that want this service,
- such as the core UIMA and UIMA-AS.
- </p>
- <p>
- The Eclipse plugs are organized into Features. These each have a project, using the naming
- convention of uimaj-eclipse-feature-xxxx. Currently we have 3 features:
- <ul>
- <li>uimaj-eclipse-feature-deployeditor (for the UIMA-AS editor for deployment descriptors)</li>
- <li>uimaj-eclipse-feature-runtime (for other plugins, and for building RCP applications)</li>
- <li>uimaj-eclipse-feature-tools (holds most of the UIMA Eclipse tooling</li>
- </ul>
- </p>
- <p>Prior to building the update site, the feature sites need to be updated to reflect the
- set of features for the current release. The build will create Jar files tagged with the
- release number, for each updated feature.</p>
- <p>
- The Eclipse update site is built in 2 phases.
- <ol>
- <li>
- <p>The first phase occurs during the normal maven
- builds of the project - this phase builds the Jars that constitute the plugins.</p>
- </li>
- <li>
- <p>
- The second consists of several parts.
- </p>
- <p>The set of feature projects, uimaj-eclipse-feature-xxxxx, must all be updated for
- the current release. Generally, only the <code>pom.xml</code> and <code>feature.xml</code> files will
- need updating.</p>
- <p>Update the uimaj-eclipse-update-site project for the release: the files <code>pom.xml</code>
- and <code>site.xml</code>. Then execute the maven command <code>mvn install</code> on the uimaj-eclipse-update-site project.
- The POM for this is an aggregator POM and will recursively invoke <code>install</code> on the uimaj-eclipse-feature-xxxxx
- projects, to build their Jars.</p>
-
- <p>The result of running <code>mvn install</code> will be a partial, but working Eclipse update site, located
- in the project's target/eclipse-update-site directory. It is partial, because the real update site keeps
- back level versions of the feature and plugin jars, while this site will only have jars for the current release.
- When uploading to the distribution point after the release is approved, be sure to merge in those jars.
- The feature Jars (in the uimaj-eclipse-update-site/features directory) for the new update site are checked into SVN,
- for use by future builds.</p>
- </li>
- </ol>
- </p>
- </blockquote>
- </td></tr>
- </table>
+ The build process for UIMA-AS is similar. You can use the extractAndBuild script from the
+ distribution directories: uima-as-distr/src/main/build for UIMA-AS
+ </p>
</blockquote>
</p>
</td></tr>
@@ -279,30 +235,15 @@
</td></tr>
<tr><td>
<blockquote class="sectionBody">
- <table class="subsectionTable">
- <tr><td>
-
-
-
- <a name="Building AnnotatorPackage distribution">
- <h2>Building AnnotatorPackage distribution
- </h2>
- </a>
- </td></tr>
- <tr><td>
- <blockquote class="subsectionBody">
<p>
To build the Sandbox AnnotatorPackage distribution, you need a working Maven development
environment as for example set up for UIMA core. With the help of
the scripts in <code>SandboxDistr/annotator-package/build</code> you can create your own distribution.
- Start out in an empty directory and run: <blockquote> <code>extractAndBuild.sh <tag name></code> </blockquote>
+ Start out in an empty directory and run: <blockquote> <code>extractAndBuild.bat <tag name></code> </blockquote>
This will extract the source code with the specified tag name from the SVN, compile and run the tests,
and finally build the distribution artifacts.
</p>
</blockquote>
- </td></tr>
- </table>
- </blockquote>
</p>
</td></tr>
</table>
@@ -345,7 +286,7 @@
create a public/private key pair with <blockquote><code>gpg --gen-key</code></blockquote>
This is pretty self-explanatory,
some more information is <a href="http://www.apache.org/dev/release-signing.html#generate">in the
- release signing FAQ</a>. Make sure to remember the passphrase you choose when creating the key,
+ release signing FAQ</a>. It is vital that you remember the passphrase you choose when creating the key;
you will need it later for using your private key to sign the release.
</p>
<p>
Modified: incubator/uima/site/trunk/uima-website/docs/release.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/release.html?rev=824572&r1=824571&r2=824572&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/release.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/release.html Tue Oct 13 02:28:16 2009
@@ -273,10 +273,13 @@
Update both versions (text and HTML) of the release notes for the release. JIRA can provide a list of
issues for a certain release when using the 'ReleaseNotes' function.
</li>
- <li>
- Do a quick release audit if for example all license headers are in place by using the
- <a href="http://incubator.apache.org/rat/">RAT</a> (Release Audit Tool) tool.
- </li>
+ <li>
+ Do a trial build of the release candidate:
+ cd **directory for building the components**
+ mv install
+ cd **directory for creating the distribution**
+ mv install
+ </li>
</ul>
</p>
</blockquote>
@@ -353,7 +356,12 @@
<tr><td>
<blockquote class="subsectionBody">
<p>
- To audit the release the <a href="http://incubator.apache.org/rat/">RAT</a> (Release Audit Tool)
+ Releases are now automatically checked using the RAT tool. Any exceptions are recorded
+ in the distribution POM, as part of the configuration for the maven RAT plugin.
+
+ </p>
+ <p>There is one exception: the uimacpp release is still separately audited.
+ To audit a uiamcpp the <a href="http://incubator.apache.org/rat/">RAT</a> (Release Audit Tool)
should be used. Check out the latest version from the website and run the tool on the unpacked release
artifacts (binary and source distribution). The command line looks like:<br /><br />
<code>java -jar apache-rat-0.6.jar <release-artifact-directory> > report.txt</code><br /><br />
@@ -449,7 +457,11 @@
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
- <ul>
+ <p>
+ After the release is approved, we will have the last tagged release candidate which will correspond to the
+ official release. This should not be updated after this.
+ </p>
+ <ul>
<li>Build the Eclipse update site:
<ul>
<li>Edit the site.xml to include any new features.</li>
@@ -477,11 +489,11 @@
</ul>
</li>
- <li>Upload the release artifacts to the distribution server (via uploading to people.apache.org
+ <li><p>Upload the release artifacts to the distribution server (via uploading to people.apache.org
in the directory: <code>/www/www.apache.org/dist/incubator/uima</code>, including the
release artifacts and the Eclipse update site data. Be sure to include the gpg/md5/sha1 signatures.
Make sure the KEYS file in that uploaded directory is current. Additionally it is necessary to update
- the download page of the UIMA website to make the new release artifacts available.
+ the download page of the UIMA website to make the new release artifacts available. </p>
<ul>
<li>The Eclipse update site on w.a.o/dist/uima will have previous versions of the jars for the
features and plugins. The generated site in
@@ -492,10 +504,10 @@
</ul>
</li>
- <li>Update the documentation page with the new data on the UIMA website. The mirroring stuff is
+ <li><p>Update the documentation page with the new data on the UIMA website. The mirroring stuff is
embedded in the markup - just substitute within that markup the name of the new release
(assuming you followed the previous release's nameing conventions for the higher-level
- directories).</li>
+ directories).</p></li>
<li><p>Upload the release artifacts to the Maven Incubator repository. To start the upload the
following command must be executed from the uimaj project <br /><br />
@@ -546,11 +558,13 @@
<tr><td>
<blockquote class="subsectionBody">
<p>
- To announce the published release send and email to
- <ul>
+ To announce the published release send and email to
+ </p>
+ <ul>
<li>announce@apache.org</li>
<li>uima-user@incubator.apache.org</li>
</ul>
+ <p>
and describe the major changes of the release. The email should contain the
Apache Incubation disclaimer as long as Apache UIMA is in the incubation phase.
Announcements should be posted from the release manager's <code>apache.org</code> address,
Modified: incubator/uima/site/trunk/uima-website/docs/svn.html
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/docs/svn.html?rev=824572&r1=824571&r2=824572&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/svn.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/svn.html Tue Oct 13 02:28:16 2009
@@ -218,6 +218,18 @@
versions of the book covering 1.0 and 1.1).
</p>
<p>
+ The code for UIMA is stored in several sections:</p>
+ <ol>
+ <li>http://svn.apache.org/repos/asf/incubator/uima/uimaj - the Java code for base UIMA</li>
+ <li>http://svn.apache.org/repos/asf/incubator/uima/uima-as - the Asynchronous Scaleout add-on for base UIMA</li>
+ <li>http://svn.apache.org/repos/asf/incubator/uima/sandbox - a collection of add-ons for UIMA including annotators</li>
+ <li>http://svn.apache.org/repos/asf/incubator/uima/uimacpp - the C++ framework supporting Annotators written in C++</li>
+ </ol>
+ <p>
+ Each of these have subdirectories: trunk - for the latest, tags - for preserved copies of releases,
+ and (sometimes) branches - for special development efforts.
+</p>
+ <p>
To receive notice of commits to the repository subscribe to
<a href="mailto:uima-commits@incubator.apache.org">
uima-commits@incubator.apache.org</a> by sending email to
@@ -255,8 +267,8 @@
</td></tr>
<tr><td>
<blockquote class="sectionBody">
- <p>Anyone can check code out of Subversion. You only need to specify a
-username and password to update the Subversion repository, and only
+ <p>Anyone can check code out of Subversion. Username and password
+ are only needed to update the Subversion repository; only
UIMA committers can do that.
If you are a committer, are working from behind a firewall, or are
connected to the internet through a proxy server, please see the sections
@@ -276,8 +288,10 @@
<blockquote class="subsectionBody">
<p>Use a command like:</p>
<longquote>% svn checkout http://svn.apache.org/repos/asf/incubator/uima/uimaj/trunk<code /></longquote>
- <p>Once you have Apache UIMA checked out you can update the source
-by executing the following command from within the UIMA directory. </p>
+ <p>Once you have Apache UIMA checked out you can update your working copy
+ of the checked-out sources, to pick up any changes committed since you
+ checked things out,
+ by executing the following command from within the UIMA directory. </p>
<longquote><code>% svn update</code></longquote>
</blockquote>
</td></tr>
@@ -294,7 +308,7 @@
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
- <p>For those users who are stuck behind a corporate firewall which is
+ <p>For those users who are behind a corporate firewall which is
blocking http access to the Subversion repository, you can try to access it
via HTTPS: </p>
<longquote><code>% svn checkout \<br />
@@ -346,9 +360,9 @@
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
- <p>Everyone can access the Apache UIMA Subversion repository via HTTPS,
-but Apache UIMA Committers must checkout the Subversion repository
-via HTTPS.
+ <p>Everyone can access the Apache UIMA Subversion repository via HTTPS.
+Apache UIMA Committers must checkout the Subversion repository
+via HTTPS, in order to be able to check in changes.
</p>
<longquote><code>% svn checkout \<br />
https://svn.apache.org/repos/asf/incubator/uima/uimaj/trunk</code></longquote>
@@ -409,12 +423,15 @@
<tr><td>
<blockquote class="subsectionBody">
<p>If you make changes to Apache UIMA, and would like to contribute
-it to the project, you should open a JIRA issue and discuss the merits
-of the proposal with the developer community. If there is agreement,
+this to the project, you should open a JIRA issue and discuss the changes
+with the developer community. If there is agreement,
create a patch and attach it to the JIRA issue.
</p>
<p>
-To create a patch, execute the svn diff command. This creates a patch that
+To create a patch, use the Eclipse Team -> Create Patch command
+select the project in the Package Explorer, right click it to find
+the Team menu in the context menu). Or, use the command line and
+execute the svn diff command. This creates a patch that
can easily be uploaded to a JIRA issue. A good name for the patch includes
the JIRA issue name, e.g. UIMA-104.patch. If there are several patches
for the same JIRA issue, you might include a short identifying
@@ -446,7 +463,10 @@
password once you become a committer.
</p>
<p>
-Once your password is set, you can use a command like this to commit:
+Once your password is set, you can commit from Eclipse using the
+Team -> commit context menu. You can do this on an individual file,
+a set of files or directories (multi-select), or on whole project(s).
+You can also commit from the command line like this:
</p>
<longquote><pre>
$> svn commit --username your-username \
@@ -474,7 +494,7 @@
--password your-password --message your-message
</pre></longquote>
<p>
-Please always enter the JIRA issue key and additionally the JIRA issue link
+Please always enter the JIRA issue key or keys (if more than one issue) and optionally, the JIRA issue link
to the commit message. The issue key (e.g., UIMA-555) is important so that the JIRA SVN plugin can detect the
changes automatically. Only specifying the issue link does not work correctly, for details
please see the JIRA issue <a class="external" rel="nofollow" href="http://jira.atlassian.com/browse/SVN-37">
@@ -495,14 +515,15 @@
<tr><td>
<blockquote class="sectionBody">
<p>
-Apache UIMA uses Maven 2 to do builds. Download Maven from <a class="external" rel="nofollow" href="http://maven.apache.org">
+Apache UIMA uses Maven 2 to do builds. Release 2.2.x is required. Download Maven from <a class="external" rel="nofollow" href="http://maven.apache.org">
http://maven.apache.org</a> and add <maven-home>/bin to your path.
</p>
<p>
If you are
building from a source distribution, and want to build the DocBooks from the Docbook sources,
you need to set up your DocBook tooling by obtaining the needed parts, either from the UIMA SVN
- or from other places on the web (see below).
+ or from other places on the web (see below). Note that the PDF files only build correctly on a
+ Windows platform (due to font issues).
</p>
<table class="subsectionTable" id='building.command.line'>
<tr><td>
@@ -522,21 +543,14 @@
$> mvn install
</pre></longquote>
</p>
- <p>
-The first time you try this, you will probably get an error that <code>javax:activation:activation:jar:1.0.2</code> is not found. To resolve this,
-download <code>activation.jar</code> from <a class="external" rel="nofollow" href="http://java.sun.com/products/archive/javabeans/jaf102.html">
- http://java.sun.com/products/archive/javabeans/jaf102.html
- </a> and execute the command:
+ <p>Builds for uima-as and the sandbox projects work similarly:
<longquote><pre>
-$> mvn install:install-file \
- -DgroupId=javax.activation \
- -DartifactId=activation \
- -Dversion=1.0.2 \
- -Dpackaging=jar \
- -Dfile=/path/to/file/activation.jar
+$> cd uimaj-as
+$> mvn install
+
+$> cd Sandbox
+$> mvn install
</pre></longquote>
-then re-run the UIMA build with the command:
-<longquote><pre>$> mvn install</pre></longquote>
</p>
<p>
This should build all of the jars and run the unit tests. Each jar will be located under the <code>target</code> subdirectory of its project, for example <code>uimaj-core/target/uima-core.jar</code>.
@@ -571,10 +585,10 @@
</blockquote>
This adds a maven repository to your machine (On Windows, under documents & settings / .m2 /
repository), and sets up an Eclipse Java Build Path variable to reference it.</p></li>
- <li><p>Use Eclipse's SVN Repository explorer to checkout all the projects under uimaj/trunk. Tell it to create
- new Java projects for these.</p></li>
+ <li><p>Use Eclipse's SVN Repository explorer to checkout all the projects under uimaj/trunk.
+ Tell it to create new Java projects for these.</p></li>
<li><p>
- <code>cd uimaj</code> to switch to the Eclipse workspace for the uimaj project itself is (it has the top level
+ <code>cd uimaj</code> to switch to the Eclipse workspace project for <code>uimaj</code> (it has the top level
POM), and run the command:
<blockquote><code>mvn eclipse:eclipse</code></blockquote>
</p><p>
@@ -585,10 +599,7 @@
is needed for the Eclipse Plugins that are part of UIMA - these projects have their
"MANIFEST.MF" file built by maven from the information in the maven POMs. This step
may take a few minutes because the "install" lifecycle includes running the unit tests.
- </p><p>
- If you notice error messages that components need to be downloaded from the maven repository, it might
- tell you to redo the command using the
- <code>-DdownloadSources=true</code> parameter in order to check remote repositories for sources.</p></li>
+ </p></li>
<li><p>Return to Eclipse, and if needed, select all the projects and push F5 to "refresh" them (because the
previous command changed the .project and .classpath files). You can set your workspace to automatically
refresh - in which case skip this step.</p></li>
@@ -618,7 +629,10 @@
(Note: this kludgy procedure needs improvement)
</p>
<p>
-If you get a failure messsage, in Eclipse, use the Search facility to search Files in the workspace of type "*.txt" for the string "<<< FAILURE!"
+If you get a failure messsage, the details of the failures are logged in a file
+for each project which has a failue, in the folder target/surefire-reports.
+In Eclipse, you can use the Search facility to search Files in the workspace of type "*.txt"
+for the string "<<< FAILURE!" to locate all the failure messages.
</p>
<p>
If not using Eclipse, you can use <code>grep</code> to accomplish the same thing.
@@ -640,93 +654,40 @@
</td></tr>
<tr><td>
<blockquote class="subsectionBody">
- <p><b>Special setup to get around a Maven issue (March 2008)</b></p>
- <blockquote>
- <p>
- Building the distribution requires that Maven uses ant version 1.7.0,
- but the Maven antrun plugin is configured
- to use ant 1.6.5. As a work-around, until a version of this plugin supporting ant 1.7.0
- is available, please update your local maven repository entry for the antrun plugin as follows:
- <ul>
- <li><p>Locate the directory containing the antrun plugin's pom. On windows, it will
- be in <code>C:\Documents and Settings\[user-name]\.m2\repository\org\apache\maven\plugins\maven-antrun-plugin\1.1</code>.
- The file in this directory to modify is <code>maven-antrun-plugin-1.1.pom</code>.</p>
- </li>
- <li><p>
- Find the two dependency sections that refer to ant 1.6.5. In each of these change 2 things:
- the <code><version>1.6.5</version></code> to
- <code><version>1.7.0</version></code>, and
- above this, the <code><groupId>ant</groupId></code> to
- <code><groupId>org.apache.ant</groupId></code>
- </p>
- </li>
- </ul>
- This will tell antrun to use ant 1.7.0.
- </p>
- </blockquote>
- <p>
- Building the distribution requires some additional maven setup: you have to have Eclipse
- version 3.3 or later installed, and you have to indicate to maven where it is installed.
- In the examples below, this is shown as c:/your/path/to/eclipse.
- Note that you can type the slashes '/' as backslashes '\' in Windows -- it doesn't matter
- (both work). The path should be to an directory (which, by default is
- often named "eclipse" but can be named anything) containing the eclipse
- executable, and the subdirectory folders for Eclipse such as "plugins"
- and "features".
- </p>
- <p>
- You can do this in one of 3 ways.
- </p>
- <p>The first way is to create a maven "settings.xml" file, and store it
- in your local maven repository, (for instance,
- on Windows, in the directory: Documents and Settings/[user-login]/.m2). This file is
- useful for other things as well, such as specifying upload servers. The file contents that
- you need to specify the Eclipse location looks like this:
-</p>
- <pre>
-<settings xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation=
- "http://maven.apache.org/POM/4.0.0
- http://maven.apache.org/xsd/settings-1.0.0.xsd">
- <profiles>
- <profile>
- <id>local-build-configuration</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <properties>
- <uima-maven-build-eclipse-home>
- c:/your/path/to/eclipse
- </uima-maven-build-eclipse-home>
- </properties>
- </profile>
- </profiles>
- <activeProfiles>
- <activeProfile>
- local-build-configuration
- </activeProfile>
- </activeProfiles>
-</settings>
- </pre>
- <p>The second way to do this is to set an environment variable. Here's an example in Windows:</p>
- <longquote><code>set ECLIPSE_HOME=c:/your/path/to/eclipse</code></longquote>
- <p>The third way is to pass a command line argument to the maven command below, which looks like this:</p>
- <longquote><code>-Duima-maven-build-eclipse-home=c:/your/path/to/eclipse</code></longquote>
+ <p>Distributions include zip/tar packages of source or binaries.
+ Please refer to this page: <a href="distribution.html">Building a distribution</a> for
+ details on how to do this.</p>
<p>
To build a distribution, first do a build as described in "Building from the command line".
Then (assuming you set up the Eclipse path using one of the first 2 methods, execute the following:
<longquote><pre>
-$>cd ../uimaj-distr
-$>mvn assembly:assembly
+cd ../uimaj-distr
+mvn install
</pre></longquote>
-
+</p>
+ <p>
This will build the javadocs and the manual (using docbooks, as described below), will create the
Eclipse update site for the Eclipse plugins, and will create
.zip, .tar.gz, and .tar.bz2 archives of the full UIMA distribution in the <code>uimaj-distr/target</code>
directory.
</p>
+ <p>Similarly, for building the uima-as add-on, do:
+<longquote><pre>
+cd uimaj-as
+mvn install
+cd ..\uima-as-distr
+mvn install
+</pre></longquote>
+</p>
+ <p>Similarly, for building the sandbox distribution projects, do:
+<longquote><pre>
+cd SandboxDistr
+mvn install
+cd annotator-package
+mvn install
+</pre></longquote>
+</p>
</blockquote>
</td></tr>
</table>
Modified: incubator/uima/site/trunk/uima-website/xdocs/distribution.xml
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/distribution.xml?rev=824572&r1=824571&r2=824572&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/xdocs/distribution.xml (original)
+++ incubator/uima/site/trunk/uima-website/xdocs/distribution.xml Tue Oct 13 02:28:16 2009
@@ -30,12 +30,10 @@
<p>
<ul>
- <li><a href="#Building the Apache UIMA core distribution">Building the Apache UIMA core distribution</a></li>
- <li><a href="#Building Apache UIMA Sandbox distributions">Building Apache UIMA Sandbox distributions</a>
- <ul>
- <li><a href="#Building AnnotatorPackage distribution">Building AnnotatorPackage distribution</a></li>
- </ul>
- </li>
+ <li><a href="#Building the Apache UIMA base distribution">Building the Apache UIMA base distribution</a></li>
+ <li><a href="#Building the Apache UIMA-AS distribution">Building the Apache UIMA-AS distribution</a></li>
+ <li><a href="#Building Apache UIMA Sandbox distributions">Building Apache UIMA Sandbox distributions</a></li>
+ <li><a href="#Building the Eclipse Update Site">Building the Eclipse Update Site</a></li>
<li><a href="#Signing a distribution">Signing a distribution</a>
<ul>
<li><a href="#Getting started with release signing">Getting started with release signing</a></li>
@@ -47,29 +45,49 @@
</p>
</section>
-<section name="Building the Apache UIMA core distribution">
+<section name="Building the Apache UIMA base distribution">
<p>
- To build a distribution, you will need to set up your Maven development environment as described
- on the <a href="./svn.html">source code page</a>. Try extracting and building the code manually
- as described there. Once you have all that working, you can build a distribution with the help
+ Start by extracting and building the code manually as described on the
+ <a href="./svn.html">source code page</a>.
+ Once you have all that working, you can build a distribution with the help
of the scripts in <code>uimaj-distr/src/main/build</code>. Start out in an empty directory and
- run: <blockquote> <code>extractAndBuild.sh</code> </blockquote>
+ run: <blockquote> <code>extractAndBuild.bat</code>
+ from the uimaj-distr/src/main/build directory.</blockquote>
This will extract the source code from SVN, compile and run the tests, and finally build the
- distribution artifacts.
- </p>
- <p>The build process for base UIMA builds individual Jar files suitable for uploading into a maven repository, 2 assemblies
- (one for the source and one for the binary distributions), and an Eclipse update site. The
+ distribution artifacts. (It will not build the
+ <a href="#Building the Eclipse Update Site">Eclipse Update Site</a>).
+ </p>
+ <p>Note: to get the PDFs built, you have to run this on a Windows machine.</p>
+ <p>The build process for base UIMA builds individual Jar files suitable for uploading into a maven repository,
+ and 2 assemblies
+ (one for the source and one for the binary distributions). The
individual Jar files are in the <code>target</code> directories of the individual projects they
belong to. The assemblies (source and binary) are in the <code>uimaj-distr/target</code> directory.
+ </p>
+</section>
+
+<section name="Building the Apache UIMA-AS distribution">
+ <p>
+ The build process for UIMA-AS is similar. You can use the extractAndBuild script from the
+ distribution directories: uima-as-distr/src/main/build for UIMA-AS
</p>
-
- <p>
- The build process for UIMA-AS and the Sandbox projects is similar. Both have assembly projects:
- uima-as-distr and SandboxDistr.
- </p>
-
- <subsection name="Eclipse Update Site">
+
+</section>
+<section name="Building Apache UIMA Sandbox distributions">
+
+
+ <p>
+ To build the Sandbox AnnotatorPackage distribution, you need a working Maven development
+ environment as for example set up for UIMA core. With the help of
+ the scripts in <code>SandboxDistr/annotator-package/build</code> you can create your own distribution.
+ Start out in an empty directory and run: <blockquote> <code>extractAndBuild.bat <tag name></code> </blockquote>
+ This will extract the source code with the specified tag name from the SVN, compile and run the tests,
+ and finally build the distribution artifacts.
+ </p>
+</section>
+
+<subsection name="Building the Eclipse Update Site">
<p>
The Eclipse update site build is somewhat unusual, because it accumulates releases over time
@@ -84,8 +102,8 @@
<ul>
<li>uimaj-eclipse-feature-deployeditor (for the UIMA-AS editor for deployment descriptors)</li>
<li>uimaj-eclipse-feature-runtime (for other plugins, and for building RCP applications)</li>
- <li>uimaj-eclipse-feature-tools (holds most of the UIMA Eclipse tooling</li>
- </ul>
+ <li>uimaj-eclipse-feature-tools (holds most of the UIMA Eclipse tooling</li>
+ </ul>
</p>
<p>Prior to building the update site, the feature sites need to be updated to reflect the
set of features for the current release. The build will create Jar files tagged with the
@@ -105,7 +123,8 @@
the current release. Generally, only the <code>pom.xml</code> and <code>feature.xml</code> files will
need updating.</p>
<p>Update the uimaj-eclipse-update-site project for the release: the files <code>pom.xml</code>
- and <code>site.xml</code>. Then execute the maven command <code>mvn install</code> on the uimaj-eclipse-update-site project.
+ and <code>site.xml</code>. Then execute the maven command
+ <code>mvn install</code> on the uimaj-eclipse-update-site project.
The POM for this is an aggregator POM and will recursively invoke <code>install</code> on the uimaj-eclipse-feature-xxxxx
projects, to build their Jars.</p>
@@ -117,24 +136,61 @@
for use by future builds.</p>
</li>
</ol>
- </p>
- </subsection>
+ </p>
+ <p>
+ Building the Eclipse Update Site requires some additional maven setup: you have to have Eclipse
+ version 3.3 or later installed, and you have to indicate to maven where it is installed.
+ In the examples below, this is shown as c:/your/path/to/eclipse.
+ Note that you can type the slashes '/' as backslashes '\' in Windows -- it doesn't matter
+ (both work). The path should be to an directory (which, by default is
+ often named "eclipse" but can be named anything) containing the eclipse
+ executable, and the subdirectory folders for Eclipse such as "plugins"
+ and "features".
+ </p>
+ <p>
+ You can do this in one of 3 ways.
+ </p>
+ <p>The first way is to create a maven "settings.xml" file, and store it
+ in your local maven repository, (for instance,
+ on Windows, in the directory: Documents and Settings/[user-login]/.m2). This file is
+ useful for other things as well, such as specifying upload servers. The file contents that
+ you need to specify the Eclipse location looks like this:
+</p>
+<pre>
+<settings xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation=
+ "http://maven.apache.org/POM/4.0.0
+ http://maven.apache.org/xsd/settings-1.0.0.xsd">
+ <profiles>
+ <profile>
+ <id>local-build-configuration</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <properties>
+ <uima-maven-build-eclipse-home>
+ c:/your/path/to/eclipse
+ </uima-maven-build-eclipse-home>
+ </properties>
+ </profile>
+ </profiles>
+ <activeProfiles>
+ <activeProfile>
+ local-build-configuration
+ </activeProfile>
+ </activeProfiles>
+</settings>
+ </pre>
-</section>
-
-<section name="Building Apache UIMA Sandbox distributions">
-
- <subsection name="Building AnnotatorPackage distribution">
- <p>
- To build the Sandbox AnnotatorPackage distribution, you need a working Maven development
- environment as for example set up for UIMA core. With the help of
- the scripts in <code>SandboxDistr/annotator-package/build</code> you can create your own distribution.
- Start out in an empty directory and run: <blockquote> <code>extractAndBuild.sh <tag name></code> </blockquote>
- This will extract the source code with the specified tag name from the SVN, compile and run the tests,
- and finally build the distribution artifacts.
- </p>
- </subsection>
-</section>
+ <p>The second way to do this is to set an environment variable. Here's an example in Windows:</p>
+ <longquote><code>set ECLIPSE_HOME=c:/your/path/to/eclipse</code></longquote>
+
+ <p>The third way is to pass a command line argument to the maven command below, which looks like this:</p>
+ <longquote><code>-Duima-maven-build-eclipse-home=c:/your/path/to/eclipse</code></longquote>.
+
+
+</subsection>
<section name="Signing a distribution">
@@ -162,7 +218,7 @@
create a public/private key pair with <blockquote><code>gpg --gen-key</code></blockquote>
This is pretty self-explanatory,
some more information is <a href="http://www.apache.org/dev/release-signing.html#generate">in the
- release signing FAQ</a>. Make sure to remember the passphrase you choose when creating the key,
+ release signing FAQ</a>. It is vital that you remember the passphrase you choose when creating the key;
you will need it later for using your private key to sign the release.
</p>
Modified: incubator/uima/site/trunk/uima-website/xdocs/release.xml
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/release.xml?rev=824572&r1=824571&r2=824572&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/xdocs/release.xml (original)
+++ incubator/uima/site/trunk/uima-website/xdocs/release.xml Tue Oct 13 02:28:16 2009
@@ -106,11 +106,14 @@
<li>
Update both versions (text and HTML) of the release notes for the release. JIRA can provide a list of
issues for a certain release when using the 'ReleaseNotes' function.
- </li>
- <li>
- Do a quick release audit if for example all license headers are in place by using the
- <a href="http://incubator.apache.org/rat/">RAT</a> (Release Audit Tool) tool.
- </li>
+ </li>
+ <li>
+ Do a trial build of the release candidate:
+ cd **directory for building the components**
+ mv install
+ cd **directory for creating the distribution**
+ mv install
+ </li>
</ul>
</p>
</subsection>
@@ -151,8 +154,13 @@
</subsection>
<subsection name='Auditing The Release And Create A RAT report'>
- <p>
- To audit the release the <a href="http://incubator.apache.org/rat/">RAT</a> (Release Audit Tool)
+ <p>
+ Releases are now automatically checked using the RAT tool. Any exceptions are recorded
+ in the distribution POM, as part of the configuration for the maven RAT plugin.
+
+ </p>
+ <p>There is one exception: the uimacpp release is still separately audited.
+ To audit a uiamcpp the <a href="http://incubator.apache.org/rat/">RAT</a> (Release Audit Tool)
should be used. Check out the latest version from the website and run the tool on the unpacked release
artifacts (binary and source distribution). The command line looks like:<br /><br />
<code>java -jar apache-rat-0.6.jar <release-artifact-directory> > report.txt</code><br /><br />
@@ -199,8 +207,10 @@
</subsection>
<subsection name='Publish The Release'>
+ <p>
After the release is approved, we will have the last tagged release candidate which will correspond to the
- official release. This should not be updated after this.
+ official release. This should not be updated after this.
+ </p>
<ul>
<li>Build the Eclipse update site:
<ul>
@@ -229,11 +239,11 @@
</ul>
</li>
- <li>Upload the release artifacts to the distribution server (via uploading to people.apache.org
+ <li><p>Upload the release artifacts to the distribution server (via uploading to people.apache.org
in the directory: <code>/www/www.apache.org/dist/incubator/uima</code>, including the
release artifacts and the Eclipse update site data. Be sure to include the gpg/md5/sha1 signatures.
Make sure the KEYS file in that uploaded directory is current. Additionally it is necessary to update
- the download page of the UIMA website to make the new release artifacts available.
+ the download page of the UIMA website to make the new release artifacts available. </p>
<ul>
<li>The Eclipse update site on w.a.o/dist/uima will have previous versions of the jars for the
features and plugins. The generated site in
@@ -244,10 +254,10 @@
</ul>
</li>
- <li>Update the documentation page with the new data on the UIMA website. The mirroring stuff is
+ <li><p>Update the documentation page with the new data on the UIMA website. The mirroring stuff is
embedded in the markup - just substitute within that markup the name of the new release
(assuming you followed the previous release's nameing conventions for the higher-level
- directories).</li>
+ directories).</p></li>
<li><p>Upload the release artifacts to the Maven Incubator repository. To start the upload the
following command must be executed from the uimaj project <br /><br/>
@@ -286,11 +296,13 @@
<subsection name='Announce The Release'>
<p>
- To announce the published release send and email to
+ To announce the published release send and email to
+ </p>
<ul>
<li>announce@apache.org</li>
<li>uima-user@incubator.apache.org</li>
- </ul>
+ </ul>
+ <p>
and describe the major changes of the release. The email should contain the
Apache Incubation disclaimer as long as Apache UIMA is in the incubation phase.
Announcements should be posted from the release manager's <code>apache.org</code> address,
Modified: incubator/uima/site/trunk/uima-website/xdocs/svn.xml
URL: http://svn.apache.org/viewvc/incubator/uima/site/trunk/uima-website/xdocs/svn.xml?rev=824572&r1=824571&r2=824572&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/xdocs/svn.xml (original)
+++ incubator/uima/site/trunk/uima-website/xdocs/svn.xml Tue Oct 13 02:28:16 2009
@@ -77,6 +77,20 @@
Note that we are currently using Subversion 1.1.x (there are separate
versions of the book covering 1.0 and 1.1).
</p>
+
+<p>
+ The code for UIMA is stored in several sections:</p>
+ <ol>
+ <li>http://svn.apache.org/repos/asf/incubator/uima/uimaj - the Java code for base UIMA</li>
+ <li>http://svn.apache.org/repos/asf/incubator/uima/uima-as - the Asynchronous Scaleout add-on for base UIMA</li>
+ <li>http://svn.apache.org/repos/asf/incubator/uima/sandbox - a collection of add-ons for UIMA including annotators</li>
+ <li>http://svn.apache.org/repos/asf/incubator/uima/uimacpp - the C++ framework supporting Annotators written in C++</li>
+ </ol>
+<p>
+ Each of these have subdirectories: trunk - for the latest, tags - for preserved copies of releases,
+ and (sometimes) branches - for special development efforts.
+</p>
+
<p>
To receive notice of commits to the repository subscribe to
<a href="mailto:uima-commits@incubator.apache.org">
@@ -97,8 +111,8 @@
<section name="Checking Out Code Using Subversion" id="checkout.code">
-<p>Anyone can check code out of Subversion. You only need to specify a
-username and password to update the Subversion repository, and only
+<p>Anyone can check code out of Subversion. Username and password
+ are only needed to update the Subversion repository; only
UIMA committers can do that.
If you are a committer, are working from behind a firewall, or are
connected to the internet through a proxy server, please see the sections
@@ -108,13 +122,15 @@
<subsection name="Anonymous check out from Subversion" id="anonymous.checkout">
<p>Use a command like:</p>
<longquote>% svn checkout http://svn.apache.org/repos/asf/incubator/uima/uimaj/trunk<code></code></longquote>
-<p>Once you have Apache UIMA checked out you can update the source
-by executing the following command from within the UIMA directory. </p>
+<p>Once you have Apache UIMA checked out you can update your working copy
+ of the checked-out sources, to pick up any changes committed since you
+ checked things out,
+ by executing the following command from within the UIMA directory. </p>
<longquote><code>% svn update</code></longquote>
</subsection>
<subsection name="Access from behind a firewall" id="access.firewall">
-<p>For those users who are stuck behind a corporate firewall which is
+<p>For those users who are behind a corporate firewall which is
blocking http access to the Subversion repository, you can try to access it
via HTTPS: </p>
<longquote><code>% svn checkout \<br/>
@@ -144,9 +160,9 @@
<subsection name="Committer access" id="committer.access">
-<p>Everyone can access the Apache UIMA Subversion repository via HTTPS,
-but Apache UIMA Committers must checkout the Subversion repository
-via HTTPS.
+<p>Everyone can access the Apache UIMA Subversion repository via HTTPS.
+Apache UIMA Committers must checkout the Subversion repository
+via HTTPS, in order to be able to check in changes.
</p>
<longquote><code>% svn checkout \<br/>
https://svn.apache.org/repos/asf/incubator/uima/uimaj/trunk</code></longquote>
@@ -177,12 +193,15 @@
<subsection name="Submitting a patch" id="submitting.patch">
<p>If you make changes to Apache UIMA, and would like to contribute
-it to the project, you should open a JIRA issue and discuss the merits
-of the proposal with the developer community. If there is agreement,
+this to the project, you should open a JIRA issue and discuss the changes
+with the developer community. If there is agreement,
create a patch and attach it to the JIRA issue.
</p>
<p>
-To create a patch, execute the svn diff command. This creates a patch that
+To create a patch, use the Eclipse Team -> Create Patch command
+select the project in the Package Explorer, right click it to find
+the Team menu in the context menu). Or, use the command line and
+execute the svn diff command. This creates a patch that
can easily be uploaded to a JIRA issue. A good name for the patch includes
the JIRA issue name, e.g. UIMA-104.patch. If there are several patches
for the same JIRA issue, you might include a short identifying
@@ -203,7 +222,10 @@
</p>
<p>
-Once your password is set, you can use a command like this to commit:
+Once your password is set, you can commit from Eclipse using the
+Team -> commit context menu. You can do this on an individual file,
+a set of files or directories (multi-select), or on whole project(s).
+You can also commit from the command line like this:
</p>
<longquote><pre>
$> svn commit --username your-username \
@@ -231,7 +253,7 @@
--password your-password --message your-message
</pre></longquote>
<p>
-Please always enter the JIRA issue key and additionally the JIRA issue link
+Please always enter the JIRA issue key or keys (if more than one issue) and optionally, the JIRA issue link
to the commit message. The issue key (e.g., UIMA-555) is important so that the JIRA SVN plugin can detect the
changes automatically. Only specifying the issue link does not work correctly, for details
please see the JIRA issue <a class="external" rel="nofollow" href="http://jira.atlassian.com/browse/SVN-37">
@@ -242,7 +264,7 @@
<section name="Building UIMA from Source" id="building.with.maven">
<p>
-Apache UIMA uses Maven 2 to do builds. Download Maven from <a class="external" rel="nofollow" href="http://maven.apache.org">
+Apache UIMA uses Maven 2 to do builds. Release 2.2.x is required. Download Maven from <a class="external" rel="nofollow" href="http://maven.apache.org">
http://maven.apache.org</a> and add <maven-home>/bin to your path.
</p>
@@ -250,7 +272,8 @@
If you are
building from a source distribution, and want to build the DocBooks from the Docbook sources,
you need to set up your DocBook tooling by obtaining the needed parts, either from the UIMA SVN
- or from other places on the web (see below).
+ or from other places on the web (see below). Note that the PDF files only build correctly on a
+ Windows platform (due to font issues).
</p>
<subsection name="Building from the command line" id="building.command.line">
<p>
@@ -259,22 +282,17 @@
$> mvn install
</pre></longquote>
</p>
-<p>
-The first time you try this, you will probably get an error that <code>javax:activation:activation:jar:1.0.2</code> is not found. To resolve this,
-download <code>activation.jar</code> from <a class="external" rel="nofollow" href="http://java.sun.com/products/archive/javabeans/jaf102.html">
- http://java.sun.com/products/archive/javabeans/jaf102.html
- </a> and execute the command:
+
+<p>Builds for uima-as and the sandbox projects work similarly:
<longquote><pre>
-$> mvn install:install-file \
- -DgroupId=javax.activation \
- -DartifactId=activation \
- -Dversion=1.0.2 \
- -Dpackaging=jar \
- -Dfile=/path/to/file/activation.jar
+$> cd uimaj-as
+$> mvn install
+
+$> cd Sandbox
+$> mvn install
</pre></longquote>
-then re-run the UIMA build with the command:
-<longquote><pre>$> mvn install</pre></longquote>
</p>
+
<p>
This should build all of the jars and run the unit tests. Each jar will be located under the <code>target</code> subdirectory of its project, for example <code>uimaj-core/target/uima-core.jar</code>.
</p>
@@ -298,10 +316,10 @@
</blockquote>
This adds a maven repository to your machine (On Windows, under documents & settings / .m2 /
repository), and sets up an Eclipse Java Build Path variable to reference it.</p></li>
- <li><p>Use Eclipse's SVN Repository explorer to checkout all the projects under uimaj/trunk. Tell it to create
- new Java projects for these.</p></li>
+ <li><p>Use Eclipse's SVN Repository explorer to checkout all the projects under uimaj/trunk.
+ Tell it to create new Java projects for these.</p></li>
<li><p>
- <code>cd uimaj</code> to switch to the Eclipse workspace for the uimaj project itself is (it has the top level
+ <code>cd uimaj</code> to switch to the Eclipse workspace project for <code>uimaj</code> (it has the top level
POM), and run the command:
<blockquote><code>mvn eclipse:eclipse</code></blockquote>
</p><p>
@@ -312,10 +330,7 @@
is needed for the Eclipse Plugins that are part of UIMA - these projects have their
"MANIFEST.MF" file built by maven from the information in the maven POMs. This step
may take a few minutes because the "install" lifecycle includes running the unit tests.
- </p><p>
- If you notice error messages that components need to be downloaded from the maven repository, it might
- tell you to redo the command using the
- <code>-DdownloadSources=true</code> parameter in order to check remote repositories for sources.</p></li>
+ </p></li>
<li><p>Return to Eclipse, and if needed, select all the projects and push F5 to "refresh" them (because the
previous command changed the .project and .classpath files). You can set your workspace to automatically
refresh - in which case skip this step.</p></li>
@@ -333,7 +348,10 @@
(Note: this kludgy procedure needs improvement)
</p>
<p>
-If you get a failure messsage, in Eclipse, use the Search facility to search Files in the workspace of type "*.txt" for the string "<<< FAILURE!"
+If you get a failure messsage, the details of the failures are logged in a file
+for each project which has a failue, in the folder target/surefire-reports.
+In Eclipse, you can use the Search facility to search Files in the workspace of type "*.txt"
+for the string "<<< FAILURE!" to locate all the failure messages.
</p>
<p>
If not using Eclipse, you can use <code>grep</code> to accomplish the same thing.
@@ -344,96 +362,44 @@
</subsection>
<subsection name="How to build the full Apache UIMA distribution" id="build.distribution">
- <p><b>Special setup to get around a Maven issue (March 2008)</b></p>
- <blockquote>
- <p>
- Building the distribution requires that Maven uses ant version 1.7.0,
- but the Maven antrun plugin is configured
- to use ant 1.6.5. As a work-around, until a version of this plugin supporting ant 1.7.0
- is available, please update your local maven repository entry for the antrun plugin as follows:
- <ul>
- <li><p>Locate the directory containing the antrun plugin's pom. On windows, it will
- be in <code>C:\Documents and Settings\[user-name]\.m2\repository\org\apache\maven\plugins\maven-antrun-plugin\1.1</code>.
- The file in this directory to modify is <code>maven-antrun-plugin-1.1.pom</code>.</p>
- </li>
- <li><p>
- Find the two dependency sections that refer to ant 1.6.5. In each of these change 2 things:
- the <code><version>1.6.5</version></code> to
- <code><version>1.7.0</version></code>, and
- above this, the <code><groupId>ant</groupId></code> to
- <code><groupId>org.apache.ant</groupId></code>
- </p>
- </li>
- </ul>
- This will tell antrun to use ant 1.7.0.
- </p>
- </blockquote>
-<p>
- Building the distribution requires some additional maven setup: you have to have Eclipse
- version 3.3 or later installed, and you have to indicate to maven where it is installed.
- In the examples below, this is shown as c:/your/path/to/eclipse.
- Note that you can type the slashes '/' as backslashes '\' in Windows -- it doesn't matter
- (both work). The path should be to an directory (which, by default is
- often named "eclipse" but can be named anything) containing the eclipse
- executable, and the subdirectory folders for Eclipse such as "plugins"
- and "features".
- </p>
- <p>
- You can do this in one of 3 ways.
- </p>
- <p>The first way is to create a maven "settings.xml" file, and store it
- in your local maven repository, (for instance,
- on Windows, in the directory: Documents and Settings/[user-login]/.m2). This file is
- useful for other things as well, such as specifying upload servers. The file contents that
- you need to specify the Eclipse location looks like this:
-</p>
-<pre>
-<settings xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation=
- "http://maven.apache.org/POM/4.0.0
- http://maven.apache.org/xsd/settings-1.0.0.xsd">
- <profiles>
- <profile>
- <id>local-build-configuration</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <properties>
- <uima-maven-build-eclipse-home>
- c:/your/path/to/eclipse
- </uima-maven-build-eclipse-home>
- </properties>
- </profile>
- </profiles>
- <activeProfiles>
- <activeProfile>
- local-build-configuration
- </activeProfile>
- </activeProfiles>
-</settings>
- </pre>
- <p>The second way to do this is to set an environment variable. Here's an example in Windows:</p>
- <longquote><code>set ECLIPSE_HOME=c:/your/path/to/eclipse</code></longquote>
-
- <p>The third way is to pass a command line argument to the maven command below, which looks like this:</p>
- <longquote><code>-Duima-maven-build-eclipse-home=c:/your/path/to/eclipse</code></longquote>
+ <p>Distributions include zip/tar packages of source or binaries.
+ Please refer to this page: <a href="distribution.html">Building a distribution</a> for
+ details on how to do this.</p>
<p>
To build a distribution, first do a build as described in "Building from the command line".
Then (assuming you set up the Eclipse path using one of the first 2 methods, execute the following:
<longquote><pre>
-$>cd ../uimaj-distr
-$>mvn assembly:assembly
+cd ../uimaj-distr
+mvn install
</pre></longquote>
-
+</p>
+<p>
This will build the javadocs and the manual (using docbooks, as described below), will create the
Eclipse update site for the Eclipse plugins, and will create
.zip, .tar.gz, and .tar.bz2 archives of the full UIMA distribution in the <code>uimaj-distr/target</code>
directory.
</p>
+
+<p>Similarly, for building the uima-as add-on, do:
+<longquote><pre>
+cd uimaj-as
+mvn install
+cd ..\uima-as-distr
+mvn install
+</pre></longquote>
+</p>
+
+<p>Similarly, for building the sandbox distribution projects, do:
+<longquote><pre>
+cd SandboxDistr
+mvn install
+cd annotator-package
+mvn install
+</pre></longquote>
+</p>
</subsection>
<subsection name="Building uima-docbooks" id="building.docbooks">
@@ -448,6 +414,7 @@
to get the images to be rendered in the PDF output, you must obtain the
"Java Advanced Imaging" library from Sun.
</p>
+
<p>Note that the uima-docbooks project is not built using Maven; it is built by an ant script. If you
want to build the documentation without building the entire UIMA distribution,
cd to the uima-docbooks directory, and run <code>ant</code>. This will build all 4 books into the
@@ -473,8 +440,6 @@
</p>
</subsection>
-
-
</section>