diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2023-10-04 20:51:01 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-10-04 20:51:01 (GMT) |
commit | 283202bc6268843a4a4c26e2c39020791e9af929 (patch) | |
tree | 775e2b132f3402656a3a06bf1eeb8a08373ce2a2 /release_docs | |
parent | b1663686012d7c1cc10ef0792bf478442f2c0e7f (diff) | |
download | hdf5-283202bc6268843a4a4c26e2c39020791e9af929.zip hdf5-283202bc6268843a4a4c26e2c39020791e9af929.tar.gz hdf5-283202bc6268843a4a4c26e2c39020791e9af929.tar.bz2 |
Remove old EXTERNALPROJECT_ADD in favor of FETCH_CONTENT (#3624)
Diffstat (limited to 'release_docs')
-rw-r--r-- | release_docs/INSTALL_CMake.txt | 35 | ||||
-rw-r--r-- | release_docs/RELEASE.txt | 12 |
2 files changed, 28 insertions, 19 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt index f979ff3..a6306eb 100644 --- a/release_docs/INSTALL_CMake.txt +++ b/release_docs/INSTALL_CMake.txt @@ -316,11 +316,9 @@ IV. Further considerations D. Use original source packages from a compressed file by adding the following CMake options: - BUILD_SZIP_WITH_FETCHCONTENT:BOOL=ON LIBAEC_TGZ_ORIGNAME:STRING="szip_src.ext" LIBAEC_TGZ_ORIGPATH:STRING="some_location" - BUILD_ZLIB_WITH_FETCHCONTENT:BOOL=ON ZLIB_TGZ_ORIGNAME:STRING="zlib_src.ext" ZLIB_TGZ_ORIGPATH:STRING="some_location" @@ -329,8 +327,6 @@ IV. Further considerations 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. @@ -878,24 +874,25 @@ HDF5_ALLOW_EXTERNAL_SUPPORT "Allow External Library Building (NO GIT TGZ)" HDF5_ENABLE_PLUGIN_SUPPORT "Enable PLUGIN Filters" OFF HDF5_ENABLE_SZIP_SUPPORT "Use SZip Filter" ON HDF5_ENABLE_Z_LIB_SUPPORT "Enable Zlib Filters" ON -PLUGIN_USE_EXTERNAL "Use External Library Building for PLUGINS" 0 + ZLIB_USE_EXTERNAL "Use External Library Building for ZLIB" 0 +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" ON + SZIP_USE_EXTERNAL "Use External Library Building for SZIP" 0 if (HDF5_ENABLE_SZIP_SUPPORT) HDF5_ENABLE_SZIP_ENCODING "Use SZip Encoding" ON +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" ON + +PLUGIN_USE_EXTERNAL "Use External Library Building for PLUGINS" 0 if (WINDOWS) H5_DEFAULT_PLUGINDIR "%ALLUSERSPROFILE%/hdf5/lib/plugin" else () H5_DEFAULT_PLUGINDIR "/usr/local/hdf5/lib/plugin" 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" 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" ON NOTE: The BUILD_STATIC_EXECS ("Build Static Executables") option is only valid @@ -1060,15 +1057,15 @@ Available configurations presets can be displayed by executing: Using individual command presets (where <compiler-type> is GNUC or MSVC or Clang): change directory to the hdf5 source folder - cmake --presets=ci-StdShar-<compiler-type> - cmake --build --presets=ci-StdShar-<compiler-type> - ctest --presets=ci-StdShar-<compiler-type> - cpack --presets=ci-StdShar-<compiler-type> + cmake --preset ci-StdShar-<compiler-type> + cmake --build --preset ci-StdShar-<compiler-type> + ctest --preset ci-StdShar-<compiler-type> + cpack --preset ci-StdShar-<compiler-type> Using the workflow preset to configure, build, test and package the standard configuration is: change directory to the hdf5 source folder - execute "cmake --workflow --presets=ci-StdShar-<compiler-type> --fresh" + execute "cmake --workflow --preset ci-StdShar-<compiler-type> --fresh" where <compiler-type> is GNUC or MSVC or Clang Creating your own configurations @@ -1088,7 +1085,7 @@ For instance, to change the support files to use a local directory, edit CMakeUs "inherits": "ci-base", "cacheVariables": { "HDF5_ALLOW_EXTERNAL_SUPPORT": {"type": "STRING", "value": "TGZ"}, - "TGZPATH": {"type": "STRING", "value": "${sourceParentDir}/temp"} + "TGZPATH": {"type": "PATH", "value": "${sourceParentDir}/temp"} } }, { diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt index 4214631..d266877 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -47,6 +47,18 @@ New Features Configuration: ------------- + - Converted the build of libaec and zlib to use FETCH_CONTENT with CMake. + + Using the CMake FetchContent module, the external filters can populate + content at configure time via any method supported by the ExternalProject + module. Whereas ExternalProject_Add() downloads at build time, the + FetchContent module makes content available immediately, allowing the + configure step to use the content in commands like add_subdirectory(), + include() or file() operations. + + Removed HDF options for using FETCH_CONTENT explicitly: + BUILD_SZIP_WITH_FETCHCONTENT:BOOL + BUILD_ZLIB_WITH_FETCHCONTENT:BOOL - Thread-safety + static library disabled on Windows w/ CMake The thread-safety feature requires hooks in DllMain(), which is only |