OESS-65 add option to use AEC library in place of SZip

3 files changed, 20 insertions, 0 deletions

diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index e1a34c5..a0386cd 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -61,6 +61,7 @@ CMake build script:
     CTestScript.cmake
 
 External compression szip and zlib libraries:
+    LIBAEC.tar.gz
     SZip.tar.gz
     ZLib.tar.gz
 
@@ -475,6 +476,8 @@ These five steps are described in detail below.
                 set_property (CACHE HDF5_ALLOW_EXTERNAL_SUPPORT PROPERTY STRINGS NO GIT TGZ)
                 set (ZLIB_TGZ_NAME "ZLib.tar.gz" CACHE STRING "Use ZLib from compressed file" FORCE)
                 set (SZIP_TGZ_NAME "SZip.tar.gz" CACHE STRING "Use SZip from compressed file" FORCE)
+                set (SZAEC_TGZ_NAME "LIBAEC.tar.gz" CACHE STRING "Use SZip AEC from compressed file" FORCE)
+                set (USE_LIBAEC ON CACHE BOOL "Use libaec szip replacement" FORCE)
                 set (ZLIB_PACKAGE_NAME "zlib" CACHE STRING "Name of ZLIB package" FORCE)
                 set (SZIP_PACKAGE_NAME "szip" CACHE STRING "Name of SZIP package" FORCE)
 
@@ -550,12 +553,17 @@ These five steps are described in detail below.
            file) are:
                ZLIB_TGZ_NAME:STRING="zlib_src.ext"
                SZIP_TGZ_NAME:STRING="szip_src.ext"
+               LIBAEC_TGZ_NAME:STRING="liaec_src.ext"
                TGZPATH:STRING="some_location"
             where "some_location/xxxx_src.ext" is the URL or full path to
             the compressed file and where ext is the type of the compression
             file such as .bz2, .tar, .tar.gz, .tgz, or .zip. Also define
             CMAKE_BUILD_TYPE to be the configuration type.
 
+           NOTE: the USE_LIBAEC option will use the file named by LIBAEC_TGZ_NAME
+            to build SZIP instead of the file named by SZIP_TGZ_NAME. This option
+            is also used to account for the different headers and library names.
+
    4. Test HDF5
 
       To test the build, navigate to your build directory and execute:
@@ -676,6 +684,7 @@ ZLIB_USE_EXTERNAL           "Use External Library Building for ZLIB"
 SZIP_USE_EXTERNAL           "Use External Library Building for SZIP"              0
 if (HDF5_ENABLE_SZIP_SUPPORT)
     HDF5_ENABLE_SZIP_ENCODING "Use SZip Encoding"                                 OFF
+    USE_LIBAEC                "Use libaec szip replacement"                       OFF
 if (WINDOWS)
     H5_DEFAULT_PLUGINDIR    "%ALLUSERSPROFILE%/hdf5/lib/plugin"
 else ()
diff --git a/release_docs/README_HDF5_CMake b/release_docs/README_HDF5_CMake
index 5737624..f1f2999 100644
--- a/release_docs/README_HDF5_CMake
+++ b/release_docs/README_HDF5_CMake
@@ -7,6 +7,7 @@ This tar file contains
     HDF5config.cmake    CMake scripts for building HDF5
     HDF5options.cmake
     hdf5-1.13.0         HDF5 1.13.0 source
+    LIBAEC.tar.gz       source for building SZIP replacement
     SZip.tar.gz         source for building SZIP
     ZLib.tar.gz         source for building ZLIB
 
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index 6c43908..102402e 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -48,6 +48,16 @@ New Features
 
     Configuration:
     -------------
+    - CMake option to use AEC (open source SZip) library instead of SZip
+
+      The open source AEC library is a replacement library for SZip. In
+      order to use it for hdf5 the libaec CMake source was changed to add
+      "-fPIC" and exclude test files. Autotools does not build the
+      compression libraries within hdf5 builds. New option USE_LIBAEC is
+      required to compensate for the different files produced by AEC build.
+
+      (ADB - 2020/04/22, OESS-65)
+
     - CMake ConfigureChecks.cmake file now uses CHECK_STRUCT_HAS_MEMBER
 
       Some handcrafted tests in HDFTests.c has been removed and the CMake