UIMA-2314 cleaned up documentation and additional info on packaging UIMA CPP components on Mac OSX.
git-svn-id: https://svn.apache.org/repos/asf/uima/uimacpp/trunk@1295184 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/README.4src b/README.4src
index 5f09b94..ba93c83 100644
--- a/README.4src
+++ b/README.4src
@@ -61,7 +61,7 @@
2 Build the UIMA shared library and test routines:
cd root of the SVN extract
- ./configure --with-jdk=$JAVA_HOME/include --with-apr=$APR_HOME --with-icu=$ICU_HOME --with-xerces=$XERCES_HOME --with-activemq=$ACTIVEMQ_HOME
+ ./configure --with-jdk=$JAVA_INCLUDE --with-apr=$APR_HOME --with-icu=$ICU_HOME --with-xerces=$XERCES_HOME --with-activemq=$ACTIVEMQ_HOME
make
DESTDIR=`pwd` make install (or make install-strip to strip symbols to shrink the binaries)
@@ -74,7 +74,10 @@
From root of the SVN extract
make sdk ARGS=target_dir
This will build the documentation.
- Note: The documentation build requires Doxygen 1.3.6 or later.
+ Note: The documentation build requires Doxygen 1.3.6 or lahter.
+
+ To rebuild the SDK at the same target_dir, run
+ make sdk ARGS="target_dir clean"
5 Package the SDK tarball:
cd target_dir/..
@@ -87,7 +90,7 @@
Building, testing and packaging on Windows:
------------------------------
+-------------------------------------------
Set up your environment as described above. The following instructions
assume you have unpacked the source into \uimacpp-2.X.Y.
@@ -138,6 +141,21 @@
>#endif
>
+Packaging UIMA C++ annotators:
+
+On Mac OSX, the install names are embedded in the binaries. Run the following steps
+manually post build to neutralize the embedded name in the UIMA C++ binary and to change
+the dependency path in the annotator:
+
+1) changing the install name in libuima, to neutralize it:
+
+install_name_tool -id libuima.dylib $UIMACPP_HOME/install/lib/libuima.dylib
+
+2) changing the dependency path in the annotator:
+
+install_name_tool -change "/install/lib/libuima.dylib"
+"/absolute_path_to_uimacpp_home/install/lib/libuima.dylib" MyAnnotator.dylib
+
Building the dependencies: APR, ICU, Xersec-c and Activemq-cpp
--------------------------------------------------------------
@@ -153,13 +171,14 @@
and to support multi-byte payload data.
ACTIVEMQ CPP 3.2 and higher has a dependency on APR at version 1.3.8 or higher and APR-Util 1.3.8.
-For UNIX users that cannot or do not want to install these at
+For UNIX users that cannot or do not want to install these as
system root, specify DESTDIR for the install step. For example,
after building APR, install using:
DESTDIR=`pwd` make install
-Building Dependencies on Winows:
+
+Building Dependencies on Windows:
--------------------------------
ActiveMQ-CPP
diff --git a/createRelease.txt b/createRelease.txt
index c01c585..429b7fa 100644
--- a/createRelease.txt
+++ b/createRelease.txt
@@ -15,7 +15,7 @@
mkdir uimacpp-2.4.0-build
cd uimacpp-2.4.0-build
-2. checkout source from current tag
+2. checkout source from the tag
svn co https://svn.apache.org/repos/asf/uima/uimacpp/tag/uimacpp-2.4.0
3. Modify configure.ac
@@ -24,26 +24,16 @@
libtool version numbering convention. This is summarized on the
wiki page https://cwiki.apache.org/UIMA/proposed-changes-to-uima-c-build-and-packaging.html.
-4. Run configure
- define environment variable ICU_HOME, APR_HOME, XERCES_HOME, ACTIVEMQ_HOME, JAVA_INCLUDE
- ./configure --with-jdk=$JAVA_HOME/include --with-apr=$APR_HOME --with-icu=$ICU_HOME --with-xerces=$XERCES_HOME --with-activemq=$ACTIVEMQ_HOME
-
- NOTE: if you need to regenerate the configure script, run autogen.sh and
+4. Run autogen.sh to generate new configure script
check into svn the generated output files.
-5. build, test and create sdk tree
- cd uimacpp-2.4.0
- [setup env for the build]. Requires environment variables APR_HOME, ICU_HOME, XERCES_HOME, ACTIVEMQ_HOME, APU_HOME.
- make
- DESTDIR=`pwd` make install
- make check
- make sdk ARGS=`pwd`
+5. build, test and create sdk tree. Follow the instructions in README.4src.
6. create bin tarball
tar -czf uimacpp-2.4.0-bin.tgz uimacpp
7. rat scan of bin
- java -jar apache-rat-0.6.jar uimacpp > uimacpp-bin-linux-report.txt
+ java -jar apache-rat-0.8.jar -dir uimacpp -e *.vcproj docs scriptators txt README RELEASE* examples html > uimacpp-bin-linux
8. sniff test of base sdk
cd uimacpp
@@ -88,27 +78,13 @@
1. checkout source from current release branch
svn co https://svn.apache.org/repos/asf/uima/uimacpp/branches/uimacpp-2.4.0
-2. build, test and create sdk tree
- cd uimacpp-2.4.0\src
- [setup env for the build] Requires environment variables APR_HOME, ICU_HOME, XERCES_HOME, ACTIVEMQ_HOME, APU_HOME.
- winmake /build release
- winmake /build debug
- cd ..\docs
- builddocs
- cd ..\src\test
- devenv test.sln /build release
- set UIMA_HOME=someGoodUimaSDK
- fvt
- devenv test.sln /build debug
- fvt debug
- cd ..\..
- buildsdk ..
-
+2. build, test and create sdk tree following the instructions in README.4src
+
3. create bin zipfile of buildDir\uimacpp as
uimacpp-2.4.0-bin.zip
4. rat scan of bin
- java -jar apache-rat-0.6.jar uimacpp > uimacpp-bin-windows-report.txt
+ java -jar apache-rat-0.8.jar -dir uimacpp -e *.vcproj docs scriptators txt README RELEASE* examples html > uimacpp-bin-windows-report.txt
5. sniff test of base sdk
cd uimacpp
@@ -143,8 +119,8 @@
Create Source Tar ball
-The source tar ball is created by zipping up the files from svn extract of
-uimacpp.
+The source tar ball is created by zipping up the files from svn extract of UIMA C++ source.
+
The source tar ball contains all the files needed to build the Windows and/or
Linux binaries.
