diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2023-05-22 23:04:48 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-22 23:04:48 (GMT) |
commit | 8186a8ded043b383004160ec4ad239687c60d5dd (patch) | |
tree | 3f5eadbdd06bdf2f3e449c6760246a49122a154a /release_docs | |
parent | 5c2e434dc630d6e333aa4118c20d67b80df2173d (diff) | |
download | hdf5-8186a8ded043b383004160ec4ad239687c60d5dd.zip hdf5-8186a8ded043b383004160ec4ad239687c60d5dd.tar.gz hdf5-8186a8ded043b383004160ec4ad239687c60d5dd.tar.bz2 |
Fix plugin cache variable name (#2988)
* Fix plugin cache variable name
* Prefix plugin project local variables
Diffstat (limited to 'release_docs')
-rw-r--r-- | release_docs/INSTALL_CMake.txt | 20 | ||||
-rw-r--r-- | release_docs/RELEASE.txt | 6 |
2 files changed, 16 insertions, 10 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt index 766819a..1ec7615 100644 --- a/release_docs/INSTALL_CMake.txt +++ b/release_docs/INSTALL_CMake.txt @@ -325,17 +325,17 @@ IV. Further considerations ZLIB_TGZ_ORIGPATH:STRING="some_location" HDF5_ALLOW_EXTERNAL_SUPPORT:STRING="TGZ" - where "some_location" is the URL or full path to the compressed - file and ext is the type of compression file. The individual filters are - enabled by setting the BUILD_<filter>_WITH_FETCHCONTENT CMake variable to ON. + where "some_location" is the URL and by setting + ZLIB_USE_LOCALCONTENT:BOOL=OFF + LIBAEC_USE_LOCALCONTENT:BOOL=OFF + or full path to the compressed file and ext is the type of compression file. + The individual filters are enabled by setting the BUILD_<filter>_WITH_FETCHCONTENT + CMake variable to ON. Also set CMAKE_BUILD_TYPE to the configuration type during configuration. See the settings in the config/cmake/cacheinit.cmake file HDF uses for testing. The files can also be retrieved from a local path if necessary TGZPATH:STRING="some_location" - by setting - ZLIB_USE_LOCALCONTENT:BOOL=ON - LIBAEC_USE_LOCALCONTENT:BOOL=ON 3. If you plan to use compression plugins: A. Use source packages from an GIT server by adding the following CMake @@ -530,12 +530,12 @@ These five steps are described in detail below. set (ZLIB_TGZ_NAME "ZLib.tar.gz" CACHE STRING "Use HDF5_ZLib from compressed file" FORCE) 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 (ZLIB_USE_LOCALCONTENT ON CACHE BOOL "Use local file for ZLIB FetchContent" FORCE) set (LIBAEC_PACKAGE_NAME "libaec" CACHE STRING "Name of AEC SZIP package" FORCE) set (SZAEC_TGZ_NAME "LIBAEC.tar.gz" CACHE STRING "Use SZip AEC from compressed file" FORCE) set (LIBAEC_TGZ_ORIGPATH "https://github.com/MathisRosenhauer/libaec/releases/download/v1.0.6" CACHE STRING "Use LIBAEC from original location" FORCE) set (LIBAEC_TGZ_ORIGNAME "libaec-1.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) + set (LIBAEC_USE_LOCALCONTENT ON CACHE BOOL "Use local file for LIBAEC FetchContent" FORCE) ####################### # filter plugin options ####################### @@ -892,11 +892,11 @@ endif () if (BUILD_SZIP_WITH_FETCHCONTENT) LIBAEC_TGZ_ORIGPATH "Use LIBAEC from original location" "https://github.com/MathisRosenhauer/libaec/releases/download/v1.0.6/libaec-1.0.6.tar.gz" LIBAEC_TGZ_ORIGNAME "Use LIBAEC from original compressed file" "libaec-v1.0.6.tar.gz" - LIBAEC_USE_LOCALCONTENT "Use local file for LIBAEC FetchContent" OFF + LIBAEC_USE_LOCALCONTENT "Use local file for LIBAEC FetchContent" ON if (BUILD_ZLIB_WITH_FETCHCONTENT) ZLIB_TGZ_ORIGPATH "Use ZLIB from original location" "https://github.com/madler/zlib/releases/download/v1.2.13" ZLIB_TGZ_ORIGNAME "Use ZLIB from original compressed file" "zlib-1.2.13.tar.gz" - ZLIB_USE_LOCALCONTENT "Use local file for ZLIB FetchContent" OFF + ZLIB_USE_LOCALCONTENT "Use local file for ZLIB FetchContent" ON NOTE: The BUILD_STATIC_EXECS ("Build Static Executables") option is only valid diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt index f6d95b8..85a1db2 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -422,6 +422,12 @@ Bug Fixes since HDF5-1.14.0 release changed from FATAL_ERROR (which would halt the build process) to WARNING (which will print a message to stderr). Associated files and documentation were changed to match. + In addition, the default settings in the config/cmake/cacheinit.cmake file were changed to + allow CMake to disable building the filters if the tgz file could not be found. The option + to allow CMake to download the file from the original Github location requires setting + the ZLIB_USE_LOCALCONTENT option to OFF for gzip. And setting the LIBAEC_USE_LOCALCONTENT + option to OFF for libaec (szip). + Fixes GitHub issue #2926 - Fixed syntax of generator expressions used by CMake |