You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by ea...@apache.org on 2007/07/18 17:54:54 UTC

svn commit: r557302 - in /incubator/uima/uimacpp/trunk: README.4src buildSrcTree.cmd buildSrcTree.sh src/readme.tobuild

Author: eae
Date: Wed Jul 18 08:54:53 2007
New Revision: 557302

URL: http://svn.apache.org/viewvc?view=rev&rev=557302
Log:
UIMA-275 Eliminate redundant file readme.tobuild

Removed:
    incubator/uima/uimacpp/trunk/src/readme.tobuild
Modified:
    incubator/uima/uimacpp/trunk/README.4src
    incubator/uima/uimacpp/trunk/buildSrcTree.cmd
    incubator/uima/uimacpp/trunk/buildSrcTree.sh

Modified: incubator/uima/uimacpp/trunk/README.4src
URL: http://svn.apache.org/viewvc/incubator/uima/uimacpp/trunk/README.4src?view=diff&rev=557302&r1=557301&r2=557302
==============================================================================
--- incubator/uima/uimacpp/trunk/README.4src (original)
+++ incubator/uima/uimacpp/trunk/README.4src Wed Jul 18 08:54:53 2007
@@ -5,6 +5,15 @@
 Building the Apache UIMA C++ SDK
 --------------------------------
 
+The Apache UIMA C++ SDK has been built and tested in 32-bit mode
+on Linux systems with gcc versions from 3.2.3 to 4.1.0, on Windows 
+using MSVC version 8, and on MacOSX with gcc version 4.0.1.
+
+64-bit builds have only been tested on Linux with gcc 4.1.0.
+
+
+Setting up the build environment:
+---------------------------------
 The library has dependencies on the APR, ICU and Xerces-C++ libraries.
 The simplest way to resolve these dependencies is to use the copies
 included in the Apache UIMA C++ runtime package.  Install the
@@ -13,78 +22,86 @@
 
 There is also a dependency on JNI headers from a Java JDK. The build
 looks for these headers in the directory specified by JAVA_INCLUDE.
+A typical setting for JAVA_INCLUDE on Linux or Windows would be 
+$JAVA_HOME/include; on MacOSX jni.h and the other headers will be in 
+a "Headers" directory.
 
 To replace one or more of the dependent libraries with different
 versions, download and build the component(s) and specify their use
 with the environmental parameters APR_HOME, ICU_HOME, and XERCES_HOME
-pointing at the root of each. If APR version 1.x is used on Windows,
-an additional parameter must be set: APR_VER=-1
+pointing at the install directory for each component. That is, under each
+should be lib and include directories. Additional instructions for building 
+the dependent libraries are found below.
 
 
 Building, testing and packaging on Linux:
 -----------------------------------------
-Set up your environment as described above. Assuming you have unpacked
-the source into $HOME/uimacpp-2.X.Y-incubating
+Set up your environment as described above. The following instructions
+assume you have unpacked the source into $HOME/uimacpp-2.X.Y-incubating.
 
-This step can be skipped if building from a source tarball.
-When building from SVN, the GNU automake scripts must first be created.
-To create the automake scripts:
+1 Create the GNU automake scripts:
+  Note: This step is only done when building from an SVN extract;
+        it should be skipped when building from a source tarball.
+        The prebuild step requires relatively up-to-date GNU tools
+        GNU automake v1.9.2, autoconf v2.59 and libtool v1.5.6.
   cd $HOME/uimacpp-2.X.Y-incubating/src
   make -f Makefile.prebuild
 
-Build the UIMA shared library and test routines:
+2 Build the UIMA shared library and test routines:
   cd $HOME/uimacpp-2.X.Y-incubating/src
   make -f Makefile.unix install
 
-Run the test suite:
+3 Run the test suite:
   cd $HOME/uimacpp-2.X.Y-incubating/src/test
   ./fvt.sh
 
-Build the documentation:
+4 Build the documentation:
+  Note: The documentation build requires Doxygen 1.3.6 or later.
   cd $HOME/uimacpp-2.X.Y-incubating/docs
   ./builddocs.sh
 
-Build the SDK tree:
+5 Build the SDK tree:
   cd $HOME/uimacpp-2.X.Y-incubating
   ./buildsdk.sh target_dir
 
-Package the SDK tarball:
+6 Package the SDK tarball:
   cd target_dir
   tar czf uimacpp-2.X.Y-incubating-bin.tgz uimacpp
 
 
 Building, testing and packaging on Windows:
 -----------------------------
-Set up your environment as described above. Assuming you have unpacked
-the source into \uimacpp-2.X.Y-incubating
+Set up your environment as described above. The following instructions
+assume you have unpacked the source into \uimacpp-2.X.Y-incubating.
 
+1 Build the UIMA C++ framework in both release and debug:
   cd \uimacpp-2.X.Y-incubating\src
   winmake /build release
   winmake /build debug
 
-
-Build and run the test suite:
+2 Build and run the test suite:
   cd \uimacpp-2.X.Y-incubating\src\test
   devenv test.sln /build release
   fvt
 
-Build the documentation:
+3 Build the documentation:
+  Note: The documentation build requires Doxygen 1.3.6 or later.
   cd \uimacpp-2.X.Y-incubating\docs
   builddocs
 
-Build the SDK tree:
+4 Build the SDK tree:
   set MSVCRT_HOME to the directory with the msvc*.dll files required.
   cd \uimacpp-2.X.Y-incubating
   buildsdk target_dir
 
-Package the SDK zipfile by creating a compressed folder of target_dir\uimacpp
-into uimacpp-2.X.Y-incubating-bin.zip
+5 Package the SDK zipfile by creating a compressed folder of 
+  target_dir\uimacpp into uimacpp-2.X.Y-incubating-bin.zip
 
 
 Building, testing and packaging on Mac OSX:
 -------------------------------------------
 Except for one problem with APR, building is the same here as on Linux.
-For the Intel-based Mac OSX machines I have tested with, the APR function
+For the Intel-based Mac OSX machines we have tested with, the APR function
 to dynamically load shared libraries does not respect DYLD_LIBRARY_PATH.
 
 A fix is to patch dso/unix/dso.c as follows:
@@ -95,6 +112,21 @@
 >#undef DSO_USE_DYLD
 >#endif
 >
+
+
+Building the dependencies: APR, ICU and Xersec-c
+------------------------------------------------
+Building of libuima.so & uima.dll has been tested with levels of APR up
+to v1.2.7, levels of Xerces-C++ up to v2.7.0, and levels of ICU up to
+v3.4.
+
+Download and build information for these libraries are at:
+  APR    - http://apr.apache.org/
+  ICU    - http://www.icu-project.org/
+  XERCES - http://xml.apache.org/xerces-c/
+
+If APR version 1.x is used on Windows, an additional env parameter 
+must be set: APR_VER=-1
 
 
 Disclaimer

Modified: incubator/uima/uimacpp/trunk/buildSrcTree.cmd
URL: http://svn.apache.org/viewvc/incubator/uima/uimacpp/trunk/buildSrcTree.cmd?view=diff&rev=557302&r1=557301&r2=557302
==============================================================================
--- incubator/uima/uimacpp/trunk/buildSrcTree.cmd (original)
+++ incubator/uima/uimacpp/trunk/buildSrcTree.cmd Wed Jul 18 08:54:53 2007
@@ -105,7 +105,6 @@
 xcopy /Q %UIMACPP_SOURCE%\docs\overview_and_setup.html %TARGET_DIR%\docs
 
 echo copying from %UIMACPP_SOURCE%\src
-xcopy /Q %UIMACPP_SOURCE%\src\readme.tobuild %TARGET_DIR%\src
 xcopy /Q %UIMACPP_SOURCE%\src\*.cmd %TARGET_DIR%\src
 xcopy /Q %UIMACPP_SOURCE%\src\*.sln %TARGET_DIR%\src
 xcopy /Q %UIMACPP_SOURCE%\src\*.bat %TARGET_DIR%\src

Modified: incubator/uima/uimacpp/trunk/buildSrcTree.sh
URL: http://svn.apache.org/viewvc/incubator/uima/uimacpp/trunk/buildSrcTree.sh?view=diff&rev=557302&r1=557301&r2=557302
==============================================================================
--- incubator/uima/uimacpp/trunk/buildSrcTree.sh (original)
+++ incubator/uima/uimacpp/trunk/buildSrcTree.sh Wed Jul 18 08:54:53 2007
@@ -99,7 +99,6 @@
 cp $CPL $UIMACPP_SOURCE/docs/overview_and_setup.html $target_dir/docs
 
 print -u2 "copying from $UIMACPP_SOURCE/src"
-cp $CPL $UIMACPP_SOURCE/src/readme.tobuild $target_dir/src/
 cp $CPL $UIMACPP_SOURCE/src/Makefile.in $target_dir/src/
 cp $CP $UIMACPP_SOURCE/src/aclocal.m4 $target_dir/src/
 cp $CP $UIMACPP_SOURCE/src/install-sh $target_dir/src/