Correct CMake option defaults - deprecate szip for libaec (#2778)

2 files changed, 90 insertions, 64 deletions

diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index 59edaf2..b9d8338 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -306,7 +306,7 @@ IV. Further considerations
          CMake options:
             HDF5_ALLOW_EXTERNAL_SUPPORT:STRING="TGZ"
             ZLIB_TGZ_NAME:STRING="zlib_src.ext"
-            SZIP_TGZ_NAME:STRING="szip_src.ext"
+            SZAEC_TGZ_NAME:STRING="szaec_src.ext"
             TGZPATH:STRING="some_location"
          where "some_location" is the URL or full path to the compressed
          file and ext is the type of compression file. Also set CMAKE_BUILD_TYPE
@@ -512,13 +512,20 @@ These five steps are described in detail below.
                 ########################
                 set (CMAKE_INSTALL_FRAMEWORK_PREFIX "Library/Frameworks" CACHE STRING "Frameworks installation directory" FORCE)
                 set (HDF_PACKAGE_EXT "" CACHE STRING "Name of HDF package extension" FORCE)
+                set (HDF_PACKAGE_NAMESPACE "hdf5::" CACHE STRING "Name for HDF package namespace (can be empty)" FORCE)
+                set (HDF5_BUILD_CPP_LIB ON CACHE BOOL "Build C++ support" FORCE)
                 set (HDF5_BUILD_FORTRAN ON CACHE BOOL "Build FORTRAN support" FORCE)
+                set (HDF5_BUILD_JAVA ON CACHE BOOL "Build JAVA support" FORCE)
+                set (HDF5_INSTALL_MOD_FORTRAN "NO" CACHE STRING "Copy FORTRAN mod files to include directory (NO SHARED STATIC)" FORCE)
+                set_property (CACHE HDF5_INSTALL_MOD_FORTRAN PROPERTY STRINGS NO SHARED STATIC)
+                set (HDF5_BUILD_GENERATORS ON CACHE BOOL "Build Test Generators" FORCE)
                 set (HDF5_ENABLE_Z_LIB_SUPPORT ON CACHE BOOL "Enable Zlib Filters" FORCE)
                 set (HDF5_ENABLE_SZIP_SUPPORT ON CACHE BOOL "Use SZip Filter" FORCE)
                 set (HDF5_ENABLE_SZIP_ENCODING ON CACHE BOOL "Use SZip Encoding" FORCE)
-                set (MPIEXEC_MAX_NUMPROCS "3" CACHE STRING "Minimum number of processes for HDF parallel tests" FORCE)
+                set (MPIEXEC_MAX_NUMPROCS "4" CACHE STRING "Minimum number of processes for HDF parallel tests" FORCE)
                 set (HDF5_ENABLE_ALL_WARNINGS ON CACHE BOOL "Enable all warnings" FORCE)
                 set (HDF_TEST_EXPRESS "2" CACHE STRING "Control testing framework (0-3)" FORCE)
+                set (HDF5_MINGW_STATIC_GCC_LIBS ON CACHE BOOL "Statically link libgcc/libstdc++" FORCE)
                 set (HDF5_ALLOW_EXTERNAL_SUPPORT "NO" CACHE STRING "Allow External Library Building (NO GIT TGZ)" FORCE)
                 set_property (CACHE HDF5_ALLOW_EXTERNAL_SUPPORT PROPERTY STRINGS NO GIT TGZ)
                 set (ZLIB_PACKAGE_NAME "zlib" CACHE STRING "Name of ZLIB package" FORCE)
@@ -526,11 +533,8 @@ These five steps are described in detail below.
                 set (ZLIB_TGZ_ORIGPATH "https://github.com/madler/zlib/releases/download/v1.2.13" CACHE STRING "Use ZLIB from original location" FORCE)
                 set (ZLIB_TGZ_ORIGNAME "zlib-1.2.13.tar.gz" CACHE STRING "Use ZLIB from original compressed file" FORCE)
                 set (ZLIB_USE_LOCALCONTENT OFF CACHE BOOL "Use local file for ZLIB FetchContent" FORCE)
-                set (SZIP_PACKAGE_NAME "szip" CACHE STRING "Name of SZIP package" FORCE)
                 set (LIBAEC_PACKAGE_NAME "libaec" CACHE STRING "Name of AEC SZIP package" 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 (LIBAEC_TGZ_ORIGPATH "https://github.com/MathisRosenhauer/libaec/releases/download/v1.0.6/libaec-1.0.6.tar.gz" CACHE STRING "Use LIBAEC from original location" FORCE)
                 set (LIBAEC_TGZ_ORIGNAME "libaec-v1.0.6.tar.gz" CACHE STRING "Use LIBAEC from original compressed file" FORCE)
                 set (LIBAEC_USE_LOCALCONTENT OFF CACHE BOOL "Use local file for LIBAEC FetchContent" FORCE)
@@ -614,7 +618,13 @@ These five steps are described in detail below.
                 set (ZFP_GIT_BRANCH "master" CACHE STRING "" FORCE)
                 set (ZFP_TGZ_NAME "zfp.tar.gz" CACHE STRING "Use ZFP from compressed file" FORCE)
                 set (ZFP_PACKAGE_NAME "zfp" CACHE STRING "Name of ZFP package" FORCE)
-
+                ######
+                # zstd
+                ######
+                set (ZSTD_GIT_URL "https://github.com/facebook/zstd" CACHE STRING "Use ZSTD from repository" FORCE)
+                set (ZSTD_GIT_BRANCH "dev" CACHE STRING "" FORCE)
+                set (ZSTD_TGZ_NAME "zstd.tar.gz" CACHE STRING "Use ZSTD from compressed file" FORCE)
+                set (ZSTD_PACKAGE_NAME "zstd" CACHE STRING "Name of ZSTD package" FORCE)
 
    2. Configure the cache settings
 
@@ -638,7 +648,7 @@ These five steps are described in detail below.
 
       2.2  Preferred command line example on Windows in c:\MyHDFstuff\hdf5\build directory:
 
-               cmake -C ../config/cmake/cacheinit.cmake -G "Visual Studio 12 2013" \
+               cmake -C ../config/cmake/cacheinit.cmake -G "Visual Studio 16 2019" "-Ax64"\
                -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF -DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=OFF \
                -DCMAKE_BUILD_TYPE:STRING=Release ..
 
@@ -688,7 +698,6 @@ These five steps are described in detail below.
            The options to control the TGZ URL (config/cmake/cacheinit.cmake
            file) are:
                ZLIB_TGZ_NAME:STRING="zlib_src.ext"
-               SZIP_TGZ_NAME:STRING="szip_src.ext"
                LIBAEC_TGZ_NAME:STRING="libaec_src.ext"
                PLUGIN_TGZ_NAME:STRING="plugin_src.ext"
                TGZPATH:STRING="some_location"
@@ -697,9 +706,8 @@ These five steps are described in detail below.
             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.
+           NOTE: HDF5 uses the file named by LIBAEC_TGZ_NAME to build SZIP. This
+                 is used to account for the different headers and library names.
 
    4. Test HDF5
 
@@ -767,14 +775,14 @@ if (WINDOWS)
   DISABLE_PDB_FILES "Do not install PDB files" OFF
 
 ---------------- HDF5 Build Options ---------------------
-HDF5_BUILD_CPP_LIB  "Build HDF5 C++ Library"         OFF
-HDF5_BUILD_EXAMPLES "Build HDF5 Library Examples"    ON
-HDF5_BUILD_FORTRAN  "Build FORTRAN support"          OFF
-HDF5_BUILD_JAVA     "Build JAVA support"             OFF
-HDF5_BUILD_HL_LIB   "Build HIGH Level HDF5 Library"  ON
-HDF5_BUILD_TOOLS    "Build HDF5 Tools"               ON
-HDF5_BUILD_HL_TOOLS "Build HIGH Level HDF5 Tools"    ON
-HDF5_BUILD_HL_GIF_TOOLS "Build HIGH Level HDF5 GIF Tools"    OFF
+HDF5_BUILD_CPP_LIB      "Build HDF5 C++ Library"          OFF
+HDF5_BUILD_EXAMPLES     "Build HDF5 Library Examples"     ON
+HDF5_BUILD_FORTRAN      "Build FORTRAN support"           OFF
+HDF5_BUILD_JAVA         "Build JAVA support"              OFF
+HDF5_BUILD_HL_LIB       "Build HIGH Level HDF5 Library"   ON
+HDF5_BUILD_TOOLS        "Build HDF5 Tools"                ON
+HDF5_BUILD_HL_TOOLS     "Build HIGH Level HDF5 Tools"     ON
+HDF5_BUILD_HL_GIF_TOOLS "Build HIGH Level HDF5 GIF Tools" OFF
 
 ---------------- HDF5 Folder Build Options ---------------------
 Defaults relative to $<INSTALL_PREFIX>
@@ -800,59 +808,73 @@ HDF5_INSTALL_DOC_DIR      "HDF5_INSTALL_DATA_DIR/doc/hdf5"
 
 ---------------- HDF5 Advanced Options ---------------------
 HDF5_USE_GNU_DIRS              "TRUE to use GNU Coding Standard install directory variables,
-                                FALSE to use historical settings"                             FALSE
-ONLY_SHARED_LIBS               "Only Build Shared Libraries"                                  OFF
-ALLOW_UNSUPPORTED              "Allow unsupported combinations of configure options"          OFF
-HDF5_EXTERNAL_LIB_PREFIX       "Use prefix for custom library naming."                        ""
-HDF5_DISABLE_COMPILER_WARNINGS "Disable compiler warnings"                                    OFF
-HDF5_ENABLE_ALL_WARNINGS       "Enable all warnings"                                          OFF
-HDF5_ENABLE_CODESTACK          "Enable the function stack tracing (for developer debugging)." OFF
-HDF5_ENABLE_COVERAGE           "Enable code coverage for Libraries and Programs"              OFF
-HDF5_ENABLE_DEBUG_APIS         "Turn on extra debug output in all packages"                   OFF
-HDF5_ENABLE_DEPRECATED_SYMBOLS "Enable deprecated public API symbols"                         ON
-HDF5_ENABLE_DIRECT_VFD         "Build the Direct I/O Virtual File Driver"                     OFF
-HDF5_ENABLE_EMBEDDED_LIBINFO   "embed library info into executables"                          ON
-HDF5_ENABLE_PARALLEL           "Enable parallel build (requires MPI)"                         OFF
+                                FALSE to use historical settings"                                FALSE
+ONLY_SHARED_LIBS               "Only Build Shared Libraries"                                     OFF
+ALLOW_UNSUPPORTED              "Allow unsupported combinations of configure options"             OFF
+HDF5_EXTERNAL_LIB_PREFIX       "Use prefix for custom library naming."                           ""
+HDF5_DISABLE_COMPILER_WARNINGS "Disable compiler warnings"                                       OFF
+HDF5_ENABLE_ALL_WARNINGS       "Enable all warnings"                                             OFF
+HDF5_ENABLE_CODESTACK          "Enable the function stack tracing (for developer debugging)."    OFF
+HDF5_ENABLE_COVERAGE           "Enable code coverage for Libraries and Programs"                 OFF
+HDF5_ENABLE_DEBUG_APIS         "Turn on extra debug output in all packages"                      OFF
+HDF5_ENABLE_DEPRECATED_SYMBOLS "Enable deprecated public API symbols"                            ON
+HDF5_ENABLE_DIRECT_VFD         "Build the Direct I/O Virtual File Driver"                        OFF
+HDF5_ENABLE_EMBEDDED_LIBINFO   "embed library info into executables"                             ON
+HDF5_ENABLE_PARALLEL           "Enable parallel build (requires MPI)"                            OFF
 HDF5_ENABLE_PREADWRITE         "Use pread/pwrite in sec2/log/core VFDs in place of read/write (when available)" ON
-HDF5_ENABLE_TRACE              "Enable API tracing capability"                                OFF
-HDF5_ENABLE_USING_MEMCHECKER   "Indicate that a memory checker is used"                       OFF
-HDF5_GENERATE_HEADERS          "Rebuild Generated Files"                                      ON
-HDF5_BUILD_GENERATORS          "Build Test Generators"                                        OFF
-HDF5_JAVA_PACK_JRE             "Package a JRE installer directory"                            OFF
-HDF5_NO_PACKAGES               "Do not include CPack Packaging"                               OFF
-HDF5_PACK_EXAMPLES             "Package the HDF5 Library Examples Compressed File"            OFF
-HDF5_PACK_MACOSX_FRAMEWORK     "Package the HDF5 Library in a Frameworks"                     OFF
+HDF5_ENABLE_TRACE              "Enable API tracing capability"                                   OFF
+HDF5_ENABLE_USING_MEMCHECKER   "Indicate that a memory checker is used"                          OFF
+HDF5_GENERATE_HEADERS          "Rebuild Generated Files"                                         ON
+HDF5_BUILD_GENERATORS          "Build Test Generators"                                           OFF
+HDF5_JAVA_PACK_JRE             "Package a JRE installer directory"                               OFF
+HDF5_NO_PACKAGES               "Do not include CPack Packaging"                                  OFF
+HDF5_PACK_EXAMPLES             "Package the HDF5 Library Examples Compressed File"               OFF
+HDF5_PACK_MACOSX_FRAMEWORK     "Package the HDF5 Library in a Frameworks"                        OFF
 HDF5_BUILD_FRAMEWORKS          "TRUE to build as frameworks libraries,
-                                FALSE to build according to BUILD_SHARED_LIBS"                FALSE
-HDF5_PACKAGE_EXTLIBS           "CPACK - include external libraries"                           OFF
-HDF5_STRICT_FORMAT_CHECKS      "Whether to perform strict file format checks"                 OFF
-HDF_TEST_EXPRESS               "Control testing framework (0-3)"                              "3"
-HDF5_TEST_VFD                  "Execute tests with different VFDs"                            OFF
-HDF5_TEST_PASSTHROUGH_VOL      "Execute tests with different passthrough VOL connectors"      OFF
-DEFAULT_API_VERSION            "Enable default API (v16, v18, v110, v112, v114)"              "v114"
-HDF5_USE_FOLDERS               "Enable folder grouping of projects in IDEs."                  ON
-HDF5_WANT_DATA_ACCURACY        "IF data accuracy is guaranteed during data conversions"       ON
+                                FALSE to build according to BUILD_SHARED_LIBS"                   FALSE
+HDF5_PACKAGE_EXTLIBS           "CPACK - include external libraries"                              OFF
+HDF5_STRICT_FORMAT_CHECKS      "Whether to perform strict file format checks"                    OFF
+DEFAULT_API_VERSION            "Enable default API (v16, v18, v110, v112, v114)"                 "v114"
+HDF5_USE_FOLDERS               "Enable folder grouping of projects in IDEs."                     ON
+HDF5_WANT_DATA_ACCURACY        "IF data accuracy is guaranteed during data conversions"          ON
 HDF5_WANT_DCONV_EXCEPTION      "exception handling functions is checked during data conversions" ON
-HDF5_ENABLE_THREADSAFE         "Enable Threadsafety"                                          OFF
-HDF5_MSVC_NAMING_CONVENTION    "Use MSVC Naming conventions for Shared Libraries"             OFF
-HDF5_MINGW_STATIC_GCC_LIBS     "Statically link libgcc/libstdc++"                             OFF
+HDF5_ENABLE_THREADSAFE         "Enable Threadsafety"                                             OFF
+HDF5_MSVC_NAMING_CONVENTION    "Use MSVC Naming conventions for Shared Libraries"                OFF
+HDF5_MINGW_STATIC_GCC_LIBS     "Statically link libgcc/libstdc++"                                OFF
 if (APPLE)
     HDF5_BUILD_WITH_INSTALL_NAME "Build with library install_name set to the installation path"  OFF
 if (CMAKE_BUILD_TYPE MATCHES Debug)
     HDF5_ENABLE_INSTRUMENT     "Instrument The library"                      OFF
-if (HDF5_TEST_VFD)
-    HDF5_TEST_FHEAP_VFD        "Execute fheap test with different VFDs"      ON
 if (HDF5_BUILD_FORTRAN)
-    HDF5_INSTALL_MOD_FORTRAN "Copy FORTRAN mod files to include directory (NO SHARED STATIC)" "XX"
-    if (BUILD_SHARED_LIBS AND BUILD_STATIC_LIBS) default HDF5_INSTALL_MOD_FORTRAN is SHARED
-    if (BUILD_SHARED_LIBS AND NOT BUILD_STATIC_LIBS) default HDF5_INSTALL_MOD_FORTRAN is SHARED
-    if (NOT BUILD_SHARED_LIBS AND BUILD_STATIC_LIBS) default HDF5_INSTALL_MOD_FORTRAN is STATIC
+    HDF5_INSTALL_MOD_FORTRAN "Copy FORTRAN mod files to include directory (NO SHARED STATIC)" SHARED
+    if (BUILD_SHARED_LIBS AND BUILD_STATIC_LIBS)         default HDF5_INSTALL_MOD_FORTRAN is SHARED
+    if (BUILD_SHARED_LIBS AND NOT BUILD_STATIC_LIBS)     default HDF5_INSTALL_MOD_FORTRAN is SHARED
+    if (NOT BUILD_SHARED_LIBS AND BUILD_STATIC_LIBS)     default HDF5_INSTALL_MOD_FORTRAN is STATIC
     if (NOT BUILD_SHARED_LIBS AND NOT BUILD_STATIC_LIBS) default HDF5_INSTALL_MOD_FORTRAN is SHARED
-HDF5_BUILD_DOC                 "Build documentation"                              OFF
-HDF5_ENABLE_ANALYZER_TOOLS     "enable the use of Clang tools"                    OFF
-HDF5_ENABLE_SANITIZERS         "execute the Clang sanitizer"                      OFF
-HDF5_ENABLE_FORMATTERS         "format source files"                              OFF
-TEST_SHELL_SCRIPTS             "Enable shell script tests"                        ON
+HDF5_BUILD_DOC                 "Build documentation"                                OFF
+HDF5_ENABLE_ANALYZER_TOOLS     "enable the use of Clang tools"                      OFF
+HDF5_ENABLE_SANITIZERS         "execute the Clang sanitizer"                        OFF
+HDF5_ENABLE_FORMATTERS         "format source files"                                OFF
+HDF5_DIMENSION_SCALES_NEW_REF  "Use new-style references with dimension scale APIs" OFF
+
+---------------- HDF5 Advanced Test Options ---------------------
+if (BUILD_TESTING)
+    HDF5_TEST_SERIAL               "Execute non-parallel tests"                                   ON
+    HDF5_TEST_TOOLS                "Execute tools tests"                                          ON
+    HDF5_TEST_EXAMPLES             "Execute tests on examples"                                    ON
+    HDF5_TEST_SWMR                 "Execute SWMR tests"                                           ON
+    HDF5_TEST_PARALLEL             "Execute parallel tests"                                       ON
+    HDF5_TEST_FORTRAN              "Execute fortran tests"                                        ON
+    HDF5_TEST_CPP                  "Execute cpp tests"                                            ON
+    HDF5_TEST_JAVA                 "Execute java tests"                                           ON
+    HDF_TEST_EXPRESS               "Control testing framework (0-3)"                              "3"
+    HDF5_TEST_PASSTHROUGH_VOL      "Execute tests with different passthrough VOL connectors"      OFF
+    if (HDF5_TEST_PASSTHROUGH_VOL)
+        HDF5_TEST_FHEAP_PASSTHROUGH_VOL "Execute fheap test with different passthrough VOL connectors" ON
+    HDF5_TEST_VFD                  "Execute tests with different VFDs"                            OFF
+    if (HDF5_TEST_VFD)
+        HDF5_TEST_FHEAP_VFD        "Execute fheap test with different VFDs"                       ON
+    TEST_SHELL_SCRIPTS             "Enable shell script tests"                                    ON
 
 ---------------- External Library Options ---------------------
 HDF5_ALLOW_EXTERNAL_SUPPORT "Allow External Library Building (NO GIT TGZ)"        "NO"
@@ -864,7 +886,6 @@ 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/RELEASE.txt b/release_docs/RELEASE.txt
index 4de0b94..2698b43 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -47,6 +47,11 @@ New Features
 
     Configuration:
     -------------
+    - Deprecated and removed old SZIP library in favor of LIBAEC library
+
+      LIBAEC library has been used in HDF5 binaries as the szip library of choice
+      for a few years. We are removing the options for using the old SZIP library.
+
     - Enabled instrumentation of the library by default in CMake for parallel
       debug builds