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/22 23:05:39 UTC
svn commit: r828854 - in /incubator/uima/site/trunk/uima-website:
docs/distribution.html xdocs/distribution.xml
Author: schor
Date: Thu Oct 22 21:05:39 2009
New Revision: 828854
URL: http://svn.apache.org/viewvc?rev=828854&view=rev
Log:
UIMA-1575 a typo prevented the Eclipse Update Build section from formatting.
Modified:
incubator/uima/site/trunk/uima-website/docs/distribution.html
incubator/uima/site/trunk/uima-website/xdocs/distribution.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=828854&r1=828853&r2=828854&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/docs/distribution.html (original)
+++ incubator/uima/site/trunk/uima-website/docs/distribution.html Thu Oct 22 21:05:39 2009
@@ -235,8 +235,9 @@
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,
+ Start out in an empty directory and run: </p>
+ <blockquote> <code>extractAndBuild.bat <tag name></code> </blockquote>
+ <p>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>
@@ -246,6 +247,113 @@
<div class="sectionTable">
<table class="sectionTable">
<tr><td>
+ <a name="Building the Eclipse Update Site"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Building the Eclipse Update Site</h1></a>
+ </td></tr>
+ <tr><td>
+ <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>
+ <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>
+ <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>
+ </blockquote>
+ </p>
+ </td></tr>
+ </table>
+ <div class="sectionTable">
+ <table class="sectionTable">
+ <tr><td>
<a name="Signing a distribution"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Signing a distribution</h1></a>
</td></tr>
<tr><td>
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=828854&r1=828853&r2=828854&view=diff
==============================================================================
--- incubator/uima/site/trunk/uima-website/xdocs/distribution.xml (original)
+++ incubator/uima/site/trunk/uima-website/xdocs/distribution.xml Thu Oct 22 21:05:39 2009
@@ -81,13 +81,14 @@
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,
+ Start out in an empty directory and run: </p>
+ <blockquote> <code>extractAndBuild.bat <tag name></code> </blockquote>
+ <p>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">
+<section name="Building the Eclipse Update Site">
<p>
The Eclipse update site build is somewhat unusual, because it accumulates releases over time
@@ -190,7 +191,7 @@
<longquote><code>-Duima-maven-build-eclipse-home=c:/your/path/to/eclipse</code></longquote>.
-</subsection>
+</section>
<section name="Signing a distribution">