From 6db28d6f9f55a6d270f53a17f0e7f213abfb253f Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Tue, 22 Oct 2024 11:42:40 -0700 Subject: [PATCH 1/3] Remove bin/cmakehdf5 This was an unsupported build script to make building the library with CMake look like building it with the Autotools. It hasn't been maintained in a long time and we've had it marked as deprecated for years. --- bin/README.md | 1 - bin/cmakehdf5 | 387 --------------------------------------- release_docs/RELEASE.txt | 6 + 3 files changed, 6 insertions(+), 388 deletions(-) delete mode 100755 bin/cmakehdf5 diff --git a/bin/README.md b/bin/README.md index 28559f0ba60..a7f786ba216 100644 --- a/bin/README.md +++ b/bin/README.md @@ -7,7 +7,6 @@ Programs run via `autogen.sh` (or the equivalent in CMake) are indicated. |`buildhdf5`|Convenience script to build HDF5 using the Autotools| |`checkapi`|Checks if public API calls are used in internal functions| |`chkcopyright`|Checks if files have appropriate copyright statements| -|`cmakehdf5`|Convenience script to build HDF5 using CMake| |`debug-ohdr`|Examines debug output from `H5O_open/close` to look for open objects| |`format_source`|Runs `clang-format` over the source files, applying our rules| |`genparser`|Creates the flex/bison-based parser files in the high-level library| diff --git a/bin/cmakehdf5 b/bin/cmakehdf5 deleted file mode 100755 index 2ce05d12b81..00000000000 --- a/bin/cmakehdf5 +++ /dev/null @@ -1,387 +0,0 @@ -#!/bin/sh -echo "Deprecated: This will be removed in a future release" -# Build and Test HDF5 using cmake. - -# Copyright: The HDF Group, 2012-14 - -# Debug Print: remove the comment hash if you want DPRINT to do echo -DPRINT=: -#DPRINT=echo - -# variable names -# The "extra" number is the step number and easier to see all logfiles in -# the sorted order of steps -progname=`basename $0` # program name -configlog="#${progname}_1config.log" -makelog="#${progname}_2build.log" -testlog="#${progname}_3test.log" -packlog="#${progname}_4pack.log" -installlog="#${progname}_5install.log" -vflag=1 # verbose flag default to on. -config_summary=libhdf5.settings -exit_code=0 - -# This command should be in the source directory's bin/ -# and should have invoked as "$srcdir/bin/$progname" or -# "bin/$progname". So, by striping bin/$program from $0, -# we can find $srcdir. -if [ "$0" = "bin/${progname}" ]; then - srcdir="." # current directory -else - # $0 is $srdir/bin/$progname - srcdir=`echo $0 | sed -e s%/bin/$progname\$%%` -fi -# Sanity check -if [ ! -r $srcdir/bin/$progname ]; then - echo "encountered error while trying to find srcdir($srdir)" - exit 1 -fi - -# Cmake build options -cacheinit=$srcdir/config/cmake/cacheinit.cmake -build_cpp_lib=-DHDF5_BUILD_CPP_LIB:BOOL=OFF # C++ interface default off -build_fortran=-DHDF5_BUILD_FORTRAN:BOOL=OFF # Fortran interface default off -build_java=-DHDF5_BUILD_JAVA:BOOL=OFF # Java interface default off -build_hl_lib=-DHDF5_BUILD_HL_LIB:BOOL=ON # High Level interface default on -build_threadsafe=-DHDF5_ENABLE_THREADSAFE:BOOL=OFF # Threadsafe feature default off -build_testing=-DBUILD_TESTING:BOOL=ON # Build tests default on -build_test_shell=-DTEST_SHELL_SCRIPTS:BOOL=ON # Run shell script tests default on -build_tools=-DHDF5_BUILD_TOOLS:BOOL=ON # Build tools default on -with_zlib=-DHDF5_ENABLE_Z_LIB_SUPPORT=ON # enable zlib filter default on -with_szlib=-DHDF5_ENABLE_SZIP_SUPPORT=OFF # enables szip filter default off -szlib_path="" # szip lib path default off -shared_lib=-DBUILD_SHARED_LIBS:BOOL=ON # enables shared lib; default on -njobs="" # number of jobs (commands) to - # run simultaneously; default is - # value from $MAKE if defined, - # otherwise none (1) - -#============= -# Function definitions -#============= - -# Show user brief help page -HELP_BRIEF() -{ -cat << EOF -Usage: $progname [options] - --help: shows details help page -EOF -} - -# Show user detail help page -HELP() -{ -cat << EOF -Usage: $progname [] - where options are: - --enable-fortran | --disable-fortran: - enable or disable fortran API. Default is off. - --enable-cxx | --disable-cxx: - enable or disable c++ API. Default is off. - --enable-java | --disable-java: - enable or disable Java API. Default is off. - --enable-hl | --disable-hl: - enable or disable high level API. Default is on. - --enable-threadsafe | --disable-threadsafe: - enable or disable threadsafe feature. Default is off - --enable-shared | --disable-shared: - enable or disable shared lib. Default is on. - --enable-tools | --disable-tools: - enable or disable building tools. Default is on. - --enable-testing | --disable-testing: - enable or disable building tests. Default is on. - --with-zlib | --with-zlib= | --without-zlib: - Use zlib library for external deflate I/O filter. Default is on. - --with-szlib | --with-szlib= | --without-szlib: - Use szlib library for external deflate I/O filter. Default is on. - --njobs=<-j N>: - number of jobs (commands) to run simultaneously; default is value from - $MAKE if defined, otherwise none - --enable-verbose | --disable-verbose: - enable or disable verbose output. Default is on. - --help: shows details help page - - : the file path to the library, expect /lib and /include. -EOF -} - -# Display a time stamp -TIMESTAMP() -{ - echo "=====" "`date`" "=====" -} - - -# Do one step bracketed with time stamps -# The '< /dev/null' is needed to prevent some applications like MPI -# jobs blocked for reading when they read stdin unnecessary. -# $1 is banner message to be displayed. -# $2 is command to run -# $3 is logfile name for saving output from the command -STEP() -{ - banner="$1" - command="$2" - logfile="$3" - - echo "$banner" with output saved in $logfile - (TIMESTAMP; nerror=0 ; - echo "eval $command" - eval $command || nerror=1 ; - TIMESTAMP; exit $nerror) < /dev/null > "$logfile" 2>&1 - if [ $? -ne 0 ]; then - echo "error in '$banner'. $progname aborted." - exit 1 - fi -} - - -# Install the generated installation image file. Different platform uses -# different image files. -# Linux: HDF5--Linux.sh file -# Mac OS X: Not implemented yet -# Others: Not implemented yet -INSTALL_HDF5() -{ - myos="`uname -s`" - case "$myos" in - Linux) - install_file=./HDF5-${version}-Linux.sh - $install_file --skip-license $* - ;; - Darwin) # MacOS DMG file - # These steps were a kludge. Need proper support from Cmake engineering. - echo Darwin install step needs proper implementation. Quit. - return 1 - # - install_file=HDF5-${version}-Darwin.dmg - test -d hdf5 || mkdir hdf5 - basename=`basename $install_file .dmg` - # mount the DMG file as /Volumes/$basename - # echo 'Y' as yes for license. - echo Y | hdiutil mount $install_file - # copy the contents to the install location - cp -R "/Volumes/$basename/HDF_Group" hdf5 - # unmount the DMG file - hdiutil unmount /Volumes/$basename - ;; - *) # unknown/unsupported OS. - echo "INSTALL_HDF5: Error--unknown/unsupported OS($myos)" - return 1 - ;; - esac -} - - -# Print logfiles. -# $*: logfiles -DUMP_LOGFILE() -{ - for x in $*; do - if [ -f $x ]; then - echo "==================================" - echo "Dumping $x" - echo "==================================" - cat $x - echo "==== END $x =====" - echo - fi - done -} - - -#========== -# main -#========== - -# Show a start time stamp -TIMESTAMP - -# Initialize njobs if $MAKE is defined -if [ -n "$MAKE" ]; then - # assume all arguments are for --jobs - njobs=`echo $MAKE | cut -s -d' ' -f2-` -fi - -# Parse Cmake configure options -# --enable-XXX or --disable-XXX will enable or disable feature XXX. -# XXX can be: -# fortran Fortran interface -# cxx C++ interface -# java Java interface -# hl Highlevel interface -# testing Build tests -# tools Build tools -while [ $# -gt 0 ]; do - case "$1" in - --enable-fortran) - build_fortran=-DHDF5_BUILD_FORTRAN:BOOL=ON - ;; - --disable-fortran) - build_fortran=-DHDF5_BUILD_FORTRAN:BOOL=OFF - ;; - --enable-cxx) - build_cpp_lib=-DHDF5_BUILD_CPP_LIB:BOOL=ON - ;; - --disable-cxx) - build_cpp_lib=-DHDF5_BUILD_CPP_LIB:BOOL=OFF - ;; - --enable-java) - build_java=-DHDF5_BUILD_JAVA:BOOL=ON - ;; - --disable-java) - build_java=-DHDF5_BUILD_JAVA:BOOL=OFF - ;; - --enable-hl) - build_hl_lib=-DHDF5_BUILD_HL_LIB:BOOL=ON - ;; - --disable-hl) - build_hl_lib=-DHDF5_BUILD_HL_LIB:BOOL=OFF - ;; - --enable-threadsafe) - build_threadsafe=-DHDF5_ENABLE_THREADSAFE:BOOL=ON - ;; - --disable-threadsafe) - build_threadsafe=-DHDF5_ENABLE_THREADSAFE:BOOL=OFF - ;; - --enable-shared) - shared_lib=-DBUILD_SHARED_LIBS:BOOL=ON - ;; - --disable-shared) - shared_lib=-DBUILD_SHARED_LIBS:BOOL=OFF - ;; - --enable-tools) - build_tools=-DHDF5_BUILD_TOOLS:BOOL=ON - ;; - --disable-tools) - build_tools=-DHDF5_BUILD_TOOLS:BOOL=OFF - ;; - --enable-testing) - build_testing=-DBUILD_TESTING:BOOL=ON - ;; - --disable-testing) - build_testing=-DBUILD_TESTING:BOOL=OFF - ;; - --enable-shell-testing) - build_test_shell=-DTEST_SHELL_SCRIPTS:BOOL=ON - ;; - --disable-shell-testing) - build_test_shell=-DTEST_SHELL_SCRIPTS:BOOL=OFF - ;; - --with-zlib) - with_zlib=-DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=ON - ;; - --with-zlib=*) - xarg=`echo $1 | cut -d= -f2-` - with_zlib="-DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=ON -DZLIB_ROOT=$xarg" - ;; - --without-zlib) - with_zlib=-DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=OFF - ;; - --with-szlib) - with_szlib=-DHDF5_ENABLE_SZIP_SUPPORT:BOOL=ON - szlib_path="" # szlib is in default paths - ;; - --with-szlib=*) - xarg=`echo $1 | cut -d= -f2-` - with_szlib="-DHDF5_ENABLE_SZIP_SUPPORT:BOOL=ON" - szlib_path="SZIP_INSTALL=$xarg" - ;; - --without-szlib) - with_szlib=-DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF - szlib_path="" # reset the path - ;; - --njobs=*) - njobs=`echo $1 | cut -d= -f2-` - ;; - --enable-verbose) - vflag=1 - ;; - --disable-verbose) - vflag=0 - ;; - --help) - # print the detail help page and exit - HELP - exit 0 - ;; - *) - echo "Unknown options: $1" - HELP - exit 1 - ;; - esac - shift -done -$DPRINT after option parsing vflag=$vflag - -# Always display the brief help page -HELP_BRIEF - -# Verify there is a valid hdf5 source directory present -if [ ! -d $srcdir ]; then - echo $srcdir not found. Aborted. - exit 1 -fi - -# figure out version information -vers=bin/h5vers -if [ ! -x $srcdir/$vers ]; then - echo $srcdir/$vers not found or not executable. Aborted. - exit 1 -fi -version=`cd $srcdir; $vers` -if [ $? != 0 ]; then - echo $vers failed. Aborted. - exit 1 -fi - -# setup output of all the log files if verbose is on upon exit -trap \ - "if [ $vflag -ne 0 ]; then DUMP_LOGFILE \$configlog \$makelog \$testlog \$packlog \$installlog; fi" \ - 0 - -echo Running Cmake for HDF5-${version} ... -# 4. Configure the C library, tools and tests with this command: -# If successful, append the configure summary to the configure logfile. -STEP "Configure..." \ - "env ${szlib_path} \ - cmake \ - -C $cacheinit \ - $build_cpp_lib \ - $build_fortran \ - $build_java \ - $build_hl_lib \ - $build_threadsafe \ - $shared_lib \ - $build_testing \ - $build_test_shell \ - $build_tools \ - $with_zlib \ - $with_szlib \ - $srcdir" $configlog &&\ - cat src/$config_summary >> $configlog - -# 5. Build the C library, tools and tests with this command: -STEP "Build the library, tools and tests, ..." "cmake --build . --config Release -- $njobs" $makelog - -# 6. Test the C library and tools with this command: -STEP "Test the library and tools..." "ctest . -C Release $njobs" $testlog - -# 7. Create an install image with this command: -STEP "Create an install image..." "cpack -C Release CPackConfig.cmake" $packlog - -# The implementation of installation is incomplete (only works for linux). -# Screen it out for now till it is completed. -if false; then -# 8. Install with this command: -STEP "Install..." "INSTALL_HDF5" $installlog -fi - -# save the last exit code -exit_code=$? - -# Show a closing time stamp -TIMESTAMP -exit $exit_code diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt index 066d5a6ec2c..8442839e2fb 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -47,6 +47,12 @@ New Features Configuration: ------------- + - bin/cmakehdf5 has been removed + + This was an unsupported build script that made building HDF5 via CMake + work like building HDF5 via the Autotools. It has been unmaintained + for a long time, has been marked deprecated, and is being removed. + - Generated files in src are now checked into version control These files are infrequently updated and generating them adds a From 720b0057baa18ca535fbcc96ec4baee3bf7aef2e Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Tue, 22 Oct 2024 17:39:35 -0500 Subject: [PATCH 2/3] Replace COPYING with LICENSE in workflows (#4989) --- .autom4te.cfg | 2 +- .gitattributes | 1 - .github/workflows/autotools.yml | 2 +- .github/workflows/cmake-ctest.yml | 24 ++++++++++++------------ .github/workflows/cmake.yml | 2 +- .github/workflows/cve.yml | 2 +- .github/workflows/hdfeos5.yml | 2 +- .github/workflows/netcdf.yml | 2 +- .h5chkright.ini | 6 +++--- 9 files changed, 21 insertions(+), 22 deletions(-) diff --git a/.autom4te.cfg b/.autom4te.cfg index 3872ddb4400..d386cef175a 100644 --- a/.autom4te.cfg +++ b/.autom4te.cfg @@ -3,7 +3,7 @@ # # This file is part of HDF5. The full HDF5 copyright notice, including # terms governing use, modification, and redistribution, is contained in -# the COPYING file, which can be found at the root of the source code +# the LICENSE file, which can be found at the root of the source code # distribution tree, or in https://www.hdfgroup.org/licenses. # If you do not have access to either file, you may request a copy from # help@hdfgroup.org. diff --git a/.gitattributes b/.gitattributes index b03dddfc95d..7e37bf00fee 100644 --- a/.gitattributes +++ b/.gitattributes @@ -72,7 +72,6 @@ hl/tools/gif2h5/testfiles/ex_image2.h5 -text hl/tools/gif2h5/testfiles/h52giftst.h5 -text hl/tools/gif2h5/testfiles/image1.gif -text java/CMakeLists.txt -text -java/COPYING -text java/Makefile.am -text java/examples/CMakeLists.txt -text java/examples/Makefile.am -text diff --git a/.github/workflows/autotools.yml b/.github/workflows/autotools.yml index a202076005a..6bf5a8813cf 100644 --- a/.github/workflows/autotools.yml +++ b/.github/workflows/autotools.yml @@ -12,7 +12,7 @@ on: - 'doc/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - - 'COPYING**' + - 'LICENSE**' - '**.md' # Using concurrency to cancel any in-progress job or run diff --git a/.github/workflows/cmake-ctest.yml b/.github/workflows/cmake-ctest.yml index b927b3ce403..77e490269fc 100644 --- a/.github/workflows/cmake-ctest.yml +++ b/.github/workflows/cmake-ctest.yml @@ -169,8 +169,8 @@ jobs: run: | mkdir "${{ runner.workspace }}/build" mkdir "${{ runner.workspace }}/build/hdf5" - Copy-Item -Path ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING -Destination ${{ runner.workspace }}/build/hdf5/ - Copy-Item -Path ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING_LBNL_HDF5 -Destination ${{ runner.workspace }}/build/hdf5/ + Copy-Item -Path ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE -Destination ${{ runner.workspace }}/build/hdf5/ + Copy-Item -Path ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE_LBNL_HDF5 -Destination ${{ runner.workspace }}/build/hdf5/ Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-MSVC/README.md -Destination ${{ runner.workspace }}/build/hdf5/ Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-MSVC/* -Destination ${{ runner.workspace }}/build/hdf5/ -Include *.zip cd "${{ runner.workspace }}/build" @@ -261,8 +261,8 @@ jobs: run: | mkdir "${{ runner.workspace }}/build" mkdir "${{ runner.workspace }}/build/hdf5" - cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING ${{ runner.workspace }}/build/hdf5 - cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 + cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE ${{ runner.workspace }}/build/hdf5 + cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/README.md ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/*.tar.gz ${{ runner.workspace }}/build/hdf5 cd "${{ runner.workspace }}/build" @@ -498,8 +498,8 @@ jobs: run: | mkdir "${{ runner.workspace }}/build" mkdir "${{ runner.workspace }}/build/hdf5" - cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING ${{ runner.workspace }}/build/hdf5 - cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 + cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE ${{ runner.workspace }}/build/hdf5 + cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-macos-Clang/README.md ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-macos-Clang/*.tar.gz ${{ runner.workspace }}/build/hdf5 cd "${{ runner.workspace }}/build" @@ -584,8 +584,8 @@ jobs: run: | mkdir "${{ runner.workspace }}/build" mkdir "${{ runner.workspace }}/build/hdf5" - cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING ${{ runner.workspace }}/build/hdf5 - cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 + cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE ${{ runner.workspace }}/build/hdf5 + cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC-S3/README.md ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC-S3/*.tar.gz ${{ runner.workspace }}/build/hdf5 cd "${{ runner.workspace }}/build" @@ -709,8 +709,8 @@ jobs: run: | mkdir "${{ runner.workspace }}/build" mkdir "${{ runner.workspace }}/build/hdf5" - Copy-Item -Path ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING -Destination ${{ runner.workspace }}/build/hdf5/ - Copy-Item -Path ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING_LBNL_HDF5 -Destination ${{ runner.workspace }}/build/hdf5/ + Copy-Item -Path ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE -Destination ${{ runner.workspace }}/build/hdf5/ + Copy-Item -Path ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE_LBNL_HDF5 -Destination ${{ runner.workspace }}/build/hdf5/ Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/README.md -Destination ${{ runner.workspace }}/build/hdf5/ Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/* -Destination ${{ runner.workspace }}/build/hdf5/ -Include *.zip cd "${{ runner.workspace }}/build" @@ -807,8 +807,8 @@ jobs: run: | mkdir "${{ runner.workspace }}/build" mkdir "${{ runner.workspace }}/build/hdf5" - cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING ${{ runner.workspace }}/build/hdf5 - cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 + cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE ${{ runner.workspace }}/build/hdf5 + cp ${{ runner.workspace }}/hdf5/${{ steps.set-file-base.outputs.SOURCE_BASE }}/LICENSE_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/README.md ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/*.tar.gz ${{ runner.workspace }}/build/hdf5 cd "${{ runner.workspace }}/build" diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml index 7fe99c2f3cb..b15205f38ae 100644 --- a/.github/workflows/cmake.yml +++ b/.github/workflows/cmake.yml @@ -12,7 +12,7 @@ on: - 'doc/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - - 'COPYING**' + - 'LICENSE**' - '**.md' # Using concurrency to cancel any in-progress job or run diff --git a/.github/workflows/cve.yml b/.github/workflows/cve.yml index a3abb664897..8562bce6d66 100644 --- a/.github/workflows/cve.yml +++ b/.github/workflows/cve.yml @@ -12,7 +12,7 @@ on: - 'doc/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - - 'COPYING**' + - 'LICENSE**' - '**.md' # Using concurrency to cancel any in-progress job or run diff --git a/.github/workflows/hdfeos5.yml b/.github/workflows/hdfeos5.yml index 0d5cf969382..2f766ce36bb 100644 --- a/.github/workflows/hdfeos5.yml +++ b/.github/workflows/hdfeos5.yml @@ -12,7 +12,7 @@ on: - 'doc/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - - 'COPYING**' + - 'LICENSE**' - '**.md' # Using concurrency to cancel any in-progress job or run diff --git a/.github/workflows/netcdf.yml b/.github/workflows/netcdf.yml index 963f9dce673..080160d086d 100644 --- a/.github/workflows/netcdf.yml +++ b/.github/workflows/netcdf.yml @@ -12,7 +12,7 @@ on: - 'doc/**' - 'release_docs/**' - 'ACKNOWLEDGEMENTS' - - 'COPYING**' + - 'LICENSE**' - '**.md' permissions: diff --git a/.h5chkright.ini b/.h5chkright.ini index 02d3cadd48f..77eb740cfff 100644 --- a/.h5chkright.ini +++ b/.h5chkright.ini @@ -3,7 +3,7 @@ # # This file is part of HDF5. The full HDF5 copyright notice, including # terms governing use, modification, and redistribution, is contained in -# the COPYING file, which can be found at the root of the source code +# the LICENSE file, which can be found at the root of the source code # distribution tree, or in https://www.hdfgroup.org/licenses. # If you do not have access to either file, you may request a copy from # help@hdfgroup.org. @@ -17,8 +17,8 @@ # with the same name. E.g., # "prune test" skips test, fortran/test, c++/test, ... -# Skip COPYING since it is the detail Copyright notice. -skip COPYING +# Skip LICENSE since it is the detail Copyright notice. +skip LICENSE # Sort of strange to have a copyright notice in README skip README From baa1e8e2922e520df740146141d24670db970a5e Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Tue, 22 Oct 2024 17:40:54 -0500 Subject: [PATCH 3/3] Prefix remaining CMake options except for CMake BUILD* variables (#4990) --- .github/workflows/cmake-analysis.yml | 6 +-- .github/workflows/main-cmake-spc.yml | 12 ++--- .github/workflows/vol_adios2.yml | 2 +- .github/workflows/vol_async.yml | 2 +- .github/workflows/vol_cache.yml | 2 +- .github/workflows/vol_log.yml | 2 +- .github/workflows/vol_rest.yml | 2 +- CMakeLists.txt | 58 ++++++++++++------------ config/cmake-presets/hidden-presets.json | 10 ++-- config/cmake/HDF5ExampleCache.cmake | 16 +++---- config/cmake/HDFMacros.cmake | 8 ++-- config/cmake/hdf5-config.cmake.in | 2 +- config/cmake/scripts/HDF5options.cmake | 2 +- config/sanitizer/README.md | 4 +- config/sanitizer/sanitizers.cmake | 36 +++++++-------- doc/cmake-vols-fetchcontent.md | 2 +- release_docs/INSTALL_CMake.txt | 22 ++++----- release_docs/RELEASE.txt | 9 ++++ src/H5build_settings.cmake.c.in | 2 +- src/libhdf5.settings.cmake.in | 2 +- test/CMakeTests.cmake | 6 +-- 21 files changed, 108 insertions(+), 99 deletions(-) diff --git a/.github/workflows/cmake-analysis.yml b/.github/workflows/cmake-analysis.yml index 58eb6ce584f..28d0cbd54eb 100644 --- a/.github/workflows/cmake-analysis.yml +++ b/.github/workflows/cmake-analysis.yml @@ -195,7 +195,7 @@ jobs: set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_BUILD_CPP_LIB:BOOL=ON") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_BUILD_FORTRAN:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_SANITIZERS:BOOL=ON") - set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DUSE_SANITIZER:STRING=Leak") + set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_USE_SANITIZER:STRING=Leak") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_SZIP_ENCODING:BOOL=OFF") @@ -295,7 +295,7 @@ jobs: set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_BUILD_CPP_LIB:BOOL=ON") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_BUILD_FORTRAN:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_SANITIZERS:BOOL=ON") - set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DUSE_SANITIZER:STRING=Address") + set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_USE_SANITIZER:STRING=Address") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_SZIP_ENCODING:BOOL=OFF") @@ -395,7 +395,7 @@ jobs: set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_BUILD_CPP_LIB:BOOL=ON") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_BUILD_FORTRAN:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_SANITIZERS:BOOL=ON") - set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DUSE_SANITIZER:STRING=Undefined") + set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_USE_SANITIZER:STRING=Undefined") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF") set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ENABLE_SZIP_ENCODING:BOOL=OFF") diff --git a/.github/workflows/main-cmake-spc.yml b/.github/workflows/main-cmake-spc.yml index b83c80beb9f..0cee38a1608 100644 --- a/.github/workflows/main-cmake-spc.yml +++ b/.github/workflows/main-cmake-spc.yml @@ -61,7 +61,7 @@ jobs: -DHDF5_ENABLE_DIRECT_VFD:BOOL=ON \ -DHDF5_ENABLE_ROS3_VFD:BOOL=ON \ -DH5_NO_DEPRECATED_SYMBOLS:BOOL=OFF \ - -DDEFAULT_API_VERSION:STRING=v16 \ + -DHDF5_DEFAULT_API_VERSION:STRING=v16 \ $GITHUB_WORKSPACE shell: bash @@ -121,7 +121,7 @@ jobs: -DHDF5_ENABLE_DIRECT_VFD:BOOL=ON \ -DHDF5_ENABLE_ROS3_VFD:BOOL=ON \ -DH5_NO_DEPRECATED_SYMBOLS:BOOL=OFF \ - -DDEFAULT_API_VERSION:STRING=v18 \ + -DHDF5_DEFAULT_API_VERSION:STRING=v18 \ $GITHUB_WORKSPACE shell: bash @@ -181,7 +181,7 @@ jobs: -DHDF5_ENABLE_DIRECT_VFD:BOOL=ON \ -DHDF5_ENABLE_ROS3_VFD:BOOL=ON \ -DH5_NO_DEPRECATED_SYMBOLS:BOOL=OFF \ - -DDEFAULT_API_VERSION:STRING=v110 \ + -DHDF5_DEFAULT_API_VERSION:STRING=v110 \ $GITHUB_WORKSPACE shell: bash @@ -241,7 +241,7 @@ jobs: -DHDF5_ENABLE_DIRECT_VFD:BOOL=ON \ -DHDF5_ENABLE_ROS3_VFD:BOOL=ON \ -DH5_NO_DEPRECATED_SYMBOLS:BOOL=OFF \ - -DDEFAULT_API_VERSION:STRING=v112 \ + -DHDF5_DEFAULT_API_VERSION:STRING=v112 \ $GITHUB_WORKSPACE shell: bash @@ -301,7 +301,7 @@ jobs: -DHDF5_ENABLE_DIRECT_VFD:BOOL=ON \ -DHDF5_ENABLE_ROS3_VFD:BOOL=ON \ -DH5_NO_DEPRECATED_SYMBOLS:BOOL=OFF \ - -DDEFAULT_API_VERSION:STRING=v114 \ + -DHDF5_DEFAULT_API_VERSION:STRING=v114 \ $GITHUB_WORKSPACE shell: bash @@ -361,7 +361,7 @@ jobs: -DHDF5_ENABLE_DIRECT_VFD:BOOL=ON \ -DHDF5_ENABLE_ROS3_VFD:BOOL=ON \ -DH5_NO_DEPRECATED_SYMBOLS:BOOL=OFF \ - -DDEFAULT_API_VERSION:STRING=v116 \ + -DHDF5_DEFAULT_API_VERSION:STRING=v116 \ $GITHUB_WORKSPACE shell: bash diff --git a/.github/workflows/vol_adios2.yml b/.github/workflows/vol_adios2.yml index d05d35427d5..ad781c10a28 100644 --- a/.github/workflows/vol_adios2.yml +++ b/.github/workflows/vol_adios2.yml @@ -42,7 +42,7 @@ jobs: -DHDF5_TEST_API_ENABLE_ASYNC:BOOL=ON \ -DHDF5_ENABLE_PARALLEL:BOOL=ON \ -DHDF5_ENABLE_THREADSAFE:BOOL=ON \ - -DALLOW_UNSUPPORTED:BOOL=ON \ + -DHDF5_ALLOW_UNSUPPORTED:BOOL=ON \ -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF \ ${{ github.workspace }}/hdf5 cat src/libhdf5.settings diff --git a/.github/workflows/vol_async.yml b/.github/workflows/vol_async.yml index 1d6861ac503..cd631ff4def 100644 --- a/.github/workflows/vol_async.yml +++ b/.github/workflows/vol_async.yml @@ -54,7 +54,7 @@ jobs: -DHDF5_TEST_API_ENABLE_ASYNC:BOOL=ON \ -DHDF5_ENABLE_PARALLEL:BOOL=ON \ -DHDF5_ENABLE_THREADSAFE:BOOL=ON \ - -DALLOW_UNSUPPORTED:BOOL=ON \ + -DHDF5_ALLOW_UNSUPPORTED:BOOL=ON \ -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF \ -DHDF5_VOL_ALLOW_EXTERNAL:STRING="GIT" \ -DHDF5_VOL_URL01:STRING="https://github.com/HDFGroup/vol-async.git" \ diff --git a/.github/workflows/vol_cache.yml b/.github/workflows/vol_cache.yml index 70f325ca2dd..4f6a55ad04a 100644 --- a/.github/workflows/vol_cache.yml +++ b/.github/workflows/vol_cache.yml @@ -82,7 +82,7 @@ jobs: -DHDF5_TEST_API_ENABLE_ASYNC:BOOL=ON \ -DHDF5_ENABLE_PARALLEL:BOOL=ON \ -DHDF5_ENABLE_THREADSAFE:BOOL=ON \ - -DALLOW_UNSUPPORTED:BOOL=ON \ + -DHDF5_ALLOW_UNSUPPORTED:BOOL=ON \ -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF \ -DHDF5_VOL_ALLOW_EXTERNAL:STRING="GIT" \ -DHDF5_VOL_URL01:STRING="https://github.com/HDFGroup/vol-async.git" \ diff --git a/.github/workflows/vol_log.yml b/.github/workflows/vol_log.yml index a7becfd4830..20c4a816ed9 100644 --- a/.github/workflows/vol_log.yml +++ b/.github/workflows/vol_log.yml @@ -40,7 +40,7 @@ jobs: -DHDF5_TEST_API_ENABLE_ASYNC:BOOL=ON \ -DHDF5_ENABLE_PARALLEL:BOOL=ON \ -DHDF5_ENABLE_THREADSAFE:BOOL=ON \ - -DALLOW_UNSUPPORTED:BOOL=ON \ + -DHDF5_ALLOW_UNSUPPORTED:BOOL=ON \ -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF \ ${{ github.workspace }}/hdf5 cat src/libhdf5.settings diff --git a/.github/workflows/vol_rest.yml b/.github/workflows/vol_rest.yml index 487f854e9f1..882835c752e 100644 --- a/.github/workflows/vol_rest.yml +++ b/.github/workflows/vol_rest.yml @@ -56,7 +56,7 @@ jobs: -DBUILD_STATIC_LIBS=OFF \ -DHDF5_BUILD_HL_LIB:BOOL=ON \ -DHDF5_TEST_API:BOOL=ON \ - -DALLOW_UNSUPPORTED:BOOL=ON \ + -DHDF5_ALLOW_UNSUPPORTED:BOOL=ON \ -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF \ -DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=OFF \ -DHDF5_VOL_ALLOW_EXTERNAL:STRING="GIT" \ diff --git a/CMakeLists.txt b/CMakeLists.txt index 5522dc35aad..1a60d9c0c5c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -147,8 +147,8 @@ if (HDF5_USE_FOLDERS) endif () option (HDF5_NO_PACKAGES "CPACK - Disable packaging" OFF) mark_as_advanced (HDF5_NO_PACKAGES) -option (ALLOW_UNSUPPORTED "Allow unsupported combinations of configure options" OFF) -mark_as_advanced (ALLOW_UNSUPPORTED) +option (HDF5_ALLOW_UNSUPPORTED "Allow unsupported combinations of configure options" OFF) +mark_as_advanced (HDF5_ALLOW_UNSUPPORTED) #----------------------------------------------------------------------------- # Set the core names of all the libraries CORENAME is the base library name @@ -519,8 +519,8 @@ endif () #----------------------------------------------------------------------------- # Option to Build Shared and Static libs, default is both #----------------------------------------------------------------------------- -option (ONLY_SHARED_LIBS "Only Build Shared Libraries" OFF) -mark_as_advanced (ONLY_SHARED_LIBS) +option (HDF5_ONLY_SHARED_LIBS "Only Build Shared Libraries" OFF) +mark_as_advanced (HDF5_ONLY_SHARED_LIBS) option (BUILD_STATIC_LIBS "Build Static Libraries" ON) set (H5_ENABLE_STATIC_LIB NO) option (BUILD_SHARED_LIBS "Build Shared Libraries" ON) @@ -530,11 +530,11 @@ option (HDF5_BUILD_STATIC_TOOLS "Build Static Tools NOT Shared Tools" OFF) # only shared libraries/tools is true if user forces static OFF if (NOT BUILD_STATIC_LIBS) - set (ONLY_SHARED_LIBS ON CACHE BOOL "Only Build Shared Libraries" FORCE) + set (HDF5_ONLY_SHARED_LIBS ON CACHE BOOL "Only Build Shared Libraries" FORCE) endif () # only shared libraries is set ON by user then force settings -if (ONLY_SHARED_LIBS) +if (HDF5_ONLY_SHARED_LIBS) set (H5_ENABLE_STATIC_LIB NO) set (BUILD_SHARED_LIBS ON CACHE BOOL "Build Shared Libraries" FORCE) set (BUILD_STATIC_LIBS OFF CACHE BOOL "Build Static Libraries" FORCE) @@ -858,13 +858,13 @@ if (HDF5_ENABLE_SUBFILING_VFD) endif() -set (DEFAULT_API_VERSION "v118" CACHE STRING "Enable v1.16 API (v16, v18, v110, v112, v114, v116, v118)") -set_property (CACHE DEFAULT_API_VERSION PROPERTY STRINGS v16 v18 v110 v112 v114 v116 v118) +set (HDF5_DEFAULT_API_VERSION "v118" CACHE STRING "Enable v1.16 API (v16, v18, v110, v112, v114, v116, v118)") +set_property (CACHE HDF5_DEFAULT_API_VERSION PROPERTY STRINGS v16 v18 v110 v112 v114 v116 v118) #----------------------------------------------------------------------------- # Option to use 1.6.x API #----------------------------------------------------------------------------- set (H5_USE_16_API_DEFAULT 0) -if (DEFAULT_API_VERSION MATCHES "v16") +if (HDF5_DEFAULT_API_VERSION MATCHES "v16") set (H5_USE_16_API_DEFAULT 1) endif () @@ -872,7 +872,7 @@ endif () # Option to use 1.8.x API #----------------------------------------------------------------------------- set (H5_USE_18_API_DEFAULT 0) -if (DEFAULT_API_VERSION MATCHES "v18") +if (HDF5_DEFAULT_API_VERSION MATCHES "v18") set (H5_USE_18_API_DEFAULT 1) endif () @@ -880,7 +880,7 @@ endif () # Option to use 1.10.x API #----------------------------------------------------------------------------- set (H5_USE_110_API_DEFAULT 0) -if (DEFAULT_API_VERSION MATCHES "v110") +if (HDF5_DEFAULT_API_VERSION MATCHES "v110") set (H5_USE_110_API_DEFAULT 1) endif () @@ -888,7 +888,7 @@ endif () # Option to use 1.12.x API #----------------------------------------------------------------------------- set (H5_USE_112_API_DEFAULT 0) -if (DEFAULT_API_VERSION MATCHES "v112") +if (HDF5_DEFAULT_API_VERSION MATCHES "v112") set (H5_USE_112_API_DEFAULT 1) endif () @@ -896,7 +896,7 @@ endif () # Option to use 1.14.x API #----------------------------------------------------------------------------- set (H5_USE_114_API_DEFAULT 0) -if (DEFAULT_API_VERSION MATCHES "v114") +if (HDF5_DEFAULT_API_VERSION MATCHES "v114") set (H5_USE_114_API_DEFAULT 1) endif () @@ -904,18 +904,18 @@ endif () # Option to use 1.16.x API #----------------------------------------------------------------------------- set (H5_USE_116_API_DEFAULT 0) -if (DEFAULT_API_VERSION MATCHES "v116") +if (HDF5_DEFAULT_API_VERSION MATCHES "v116") set (H5_USE_116_API_DEFAULT 1) endif () #----------------------------------------------------------------------------- # Option to use 1.18.x API #----------------------------------------------------------------------------- -if (NOT DEFAULT_API_VERSION) - set (DEFAULT_API_VERSION "v118") +if (NOT HDF5_DEFAULT_API_VERSION) + set (HDF5_DEFAULT_API_VERSION "v118") endif () set (H5_USE_118_API_DEFAULT 0) -if (DEFAULT_API_VERSION MATCHES "v118") +if (HDF5_DEFAULT_API_VERSION MATCHES "v118") set (H5_USE_118_API_DEFAULT 1) endif () @@ -956,29 +956,29 @@ if (HDF5_ENABLE_THREADSAFE) endif () endif () if (HDF_ENABLE_PARALLEL) - if (NOT ALLOW_UNSUPPORTED) - message (FATAL_ERROR " **** Parallel and thread-safety options are not supported, override with ALLOW_UNSUPPORTED option **** ") + if (NOT HDF5_ALLOW_UNSUPPORTED) + message (FATAL_ERROR " **** Parallel and thread-safety options are not supported, override with HDF5_ALLOW_UNSUPPORTED option **** ") else () message (VERBOSE " **** Allowing unsupported parallel and thread-safety options **** ") endif () endif () if (HDF5_BUILD_FORTRAN) - if (NOT ALLOW_UNSUPPORTED) - message (FATAL_ERROR " **** Fortran and thread-safety options are not supported, override with ALLOW_UNSUPPORTED option **** ") + if (NOT HDF5_ALLOW_UNSUPPORTED) + message (FATAL_ERROR " **** Fortran and thread-safety options are not supported, override with HDF5_ALLOW_UNSUPPORTED option **** ") else () message (VERBOSE " **** Allowing unsupported Fortran and thread-safety options **** ") endif () endif () if (HDF5_BUILD_CPP_LIB) - if (NOT ALLOW_UNSUPPORTED) - message (FATAL_ERROR " **** C++ and thread-safety options are not supported, override with ALLOW_UNSUPPORTED option **** ") + if (NOT HDF5_ALLOW_UNSUPPORTED) + message (FATAL_ERROR " **** C++ and thread-safety options are not supported, override with HDF5_ALLOW_UNSUPPORTED option **** ") else () message (VERBOSE " **** Allowing unsupported C++ and thread-safety options **** ") endif () endif () if (HDF5_BUILD_HL_LIB) - if (NOT ALLOW_UNSUPPORTED) - message (FATAL_ERROR " **** HL and thread-safety options are not supported, override with ALLOW_UNSUPPORTED option **** ") + if (NOT HDF5_ALLOW_UNSUPPORTED) + message (FATAL_ERROR " **** HL and thread-safety options are not supported, override with HDF5_ALLOW_UNSUPPORTED option **** ") else () message (VERBOSE " **** Allowing unsupported HL and thread-safety options **** ") endif () @@ -1093,7 +1093,7 @@ endif () #----------------------------------------------------------------------------- # Include filter plugins #----------------------------------------------------------------------------- -if (${H5_LIBVER_DIR} EQUAL 16 OR DEFAULT_API_VERSION MATCHES "v16") +if (${H5_LIBVER_DIR} EQUAL 16 OR HDF5_DEFAULT_API_VERSION MATCHES "v16") set (HDF5_ENABLE_PLUGIN_SUPPORT OFF CACHE BOOL "" FORCE) message (VERBOSE "Filter PLUGINs cannot be used with 1.6 API") else () @@ -1186,8 +1186,8 @@ if (EXISTS "${HDF5_SOURCE_DIR}/c++" AND IS_DIRECTORY "${HDF5_SOURCE_DIR}/c++") if (HDF5_BUILD_CPP_LIB) # check for unsupported options if (HDF5_ENABLE_PARALLEL) - if (NOT ALLOW_UNSUPPORTED) - message (FATAL_ERROR " **** Parallel and C++ options are mutually exclusive, override with ALLOW_UNSUPPORTED option **** ") + if (NOT HDF5_ALLOW_UNSUPPORTED) + message (FATAL_ERROR " **** Parallel and C++ options are mutually exclusive, override with HDF5_ALLOW_UNSUPPORTED option **** ") else () message (VERBOSE " **** Allowing unsupported Parallel and C++ options **** ") endif () @@ -1229,7 +1229,7 @@ configure_file (${HDF_RESOURCES_DIR}/H5pubconf.h.in ${HDF5_SRC_BINARY_DIR}/H5pub #----------------------------------------------------------------------------- if (EXISTS "${HDF5_SOURCE_DIR}/HDF5Examples" AND IS_DIRECTORY "${HDF5_SOURCE_DIR}/HDF5Examples") option (HDF5_BUILD_EXAMPLES "Build HDF5 Library Examples" ON) - if (HDF5_BUILD_EXAMPLES AND NOT USE_SANITIZER) + if (HDF5_BUILD_EXAMPLES AND NOT HDF5_USE_SANITIZER) include (${HDF_RESOURCES_DIR}/HDF5ExampleCache.cmake) set (HDF5_VERSION ${HDF5_PACKAGE_VERSION}) add_subdirectory (HDF5Examples) diff --git a/config/cmake-presets/hidden-presets.json b/config/cmake-presets/hidden-presets.json index 8051eb66be0..db2c56f9fbc 100644 --- a/config/cmake-presets/hidden-presets.json +++ b/config/cmake-presets/hidden-presets.json @@ -269,7 +269,7 @@ "hidden": true, "inherits": "ci-x64-Debug-MSVC", "cacheVariables": { - "USE_SANITIZER": "Address", + "HDF5_USE_SANITIZER": "Address", "HDF5_ENABLE_SANITIZERS": "ON" } }, @@ -278,7 +278,7 @@ "hidden": true, "inherits": "ci-x64-Debug-GNUC", "cacheVariables": { - "USE_SANITIZER": "Address", + "HDF5_USE_SANITIZER": "Address", "HDF5_ENABLE_SANITIZERS": "ON" } }, @@ -287,7 +287,7 @@ "hidden": true, "inherits": "ci-x64-Debug-GNUC", "cacheVariables": { - "USE_SANITIZER": "Thread", + "HDF5_USE_SANITIZER": "Thread", "HDF5_ENABLE_SANITIZERS": "ON" } }, @@ -296,7 +296,7 @@ "hidden": true, "inherits": "ci-x64-Debug-GNUC", "cacheVariables": { - "USE_SANITIZER": "Leak", + "HDF5_USE_SANITIZER": "Leak", "HDF5_ENABLE_SANITIZERS": "ON" } }, @@ -305,7 +305,7 @@ "hidden": true, "inherits": "ci-x64-Debug-GNUC", "cacheVariables": { - "USE_SANITIZER": "Undefined", + "HDF5_USE_SANITIZER": "Undefined", "HDF5_ENABLE_SANITIZERS": "ON" } } diff --git a/config/cmake/HDF5ExampleCache.cmake b/config/cmake/HDF5ExampleCache.cmake index 219d1c59902..2b2559e79cd 100644 --- a/config/cmake/HDF5ExampleCache.cmake +++ b/config/cmake/HDF5ExampleCache.cmake @@ -26,22 +26,22 @@ set (EXAMPLES_EXTERNALLY_CONFIGURED ON CACHE BOOL "Examples build is used in ano set (EXAMPLE_VARNAME "H5") set (H5EX_RESOURCES_DIR ${HDF_RESOURCES_DIR}) message (STATUS "HDF5 Example H5EX_RESOURCES_DIR: ${H5EX_RESOURCES_DIR}") -if (DEFAULT_API_VERSION MATCHES "v16") +if (HDF5_DEFAULT_API_VERSION MATCHES "v16") set (H5_USE_16_API ON) -elseif (DEFAULT_API_VERSION MATCHES "v18") +elseif (HDF5_DEFAULT_API_VERSION MATCHES "v18") set (H5_USE_18_API ON) -elseif (DEFAULT_API_VERSION MATCHES "v110") +elseif (HDF5_DEFAULT_API_VERSION MATCHES "v110") set (H5_USE_110_API ON) -elseif (DEFAULT_API_VERSION MATCHES "v112") +elseif (HDF5_DEFAULT_API_VERSION MATCHES "v112") set (H5_USE_112_API ON) -elseif (DEFAULT_API_VERSION MATCHES "v114") +elseif (HDF5_DEFAULT_API_VERSION MATCHES "v114") set (H5_USE_114_API ON) -elseif (DEFAULT_API_VERSION MATCHES "v116") +elseif (HDF5_DEFAULT_API_VERSION MATCHES "v116") set (H5_USE_116_API ON) -elseif (DEFAULT_API_VERSION MATCHES "v118") +elseif (HDF5_DEFAULT_API_VERSION MATCHES "v118") set (H5_USE_118_API ON) endif () -message (STATUS "HDF5 H5_LIBVER_DIR: ${H5_LIBVER_DIR} HDF5_API_VERSION: ${DEFAULT_API_VERSION}") +message (STATUS "HDF5 H5_LIBVER_DIR: ${H5_LIBVER_DIR} HDF5_API_VERSION: ${HDF5_DEFAULT_API_VERSION}") if (NOT BUILD_SHARED_LIBS AND BUILD_STATIC_LIBS) set (USE_SHARED_LIBS OFF CACHE BOOL "Use Shared Libraries for Examples" FORCE) diff --git a/config/cmake/HDFMacros.cmake b/config/cmake/HDFMacros.cmake index a8ce9bb2c5b..018c7d8daa0 100644 --- a/config/cmake/HDFMacros.cmake +++ b/config/cmake/HDFMacros.cmake @@ -122,9 +122,9 @@ endmacro () #------------------------------------------------------------------------------- macro (INSTALL_TARGET_PDB libtarget targetdestination targetcomponent) - option (DISABLE_PDB_FILES "Do not install PDB files" OFF) - mark_as_advanced (DISABLE_PDB_FILES) - if (WIN32 AND MSVC AND NOT DISABLE_PDB_FILES) + option (HDF5_DISABLE_PDB_FILES "Do not install PDB files" OFF) + mark_as_advanced (HDF5_DISABLE_PDB_FILES) + if (WIN32 AND MSVC AND NOT HDF5_DISABLE_PDB_FILES) get_target_property (target_type ${libtarget} TYPE) if (${target_type} MATCHES "SHARED") set (targetfilename $) @@ -354,7 +354,7 @@ macro (HDF_README_PROPERTIES target_fortran) set (BINARY_PLATFORM "${BINARY_PLATFORM} / ${CMAKE_Fortran_COMPILER_ID} Fortran") endif () - if (ONLY_SHARED_LIBS) + if (HDF5_ONLY_SHARED_LIBS) set (LIB_TYPE "Shared") elseif (BUILD_SHARED_LIBS) set (LIB_TYPE "Static and Shared") diff --git a/config/cmake/hdf5-config.cmake.in b/config/cmake/hdf5-config.cmake.in index 5ac036d26f0..b0909b9ac01 100644 --- a/config/cmake/hdf5-config.cmake.in +++ b/config/cmake/hdf5-config.cmake.in @@ -49,7 +49,7 @@ set (${HDF5_PACKAGE_NAME}_BUILD_STATIC_LIBS @H5_ENABLE_STATIC_LIB@) set (${HDF5_PACKAGE_NAME}_ENABLE_THREADS @HDF5_ENABLE_THREADS@) set (${HDF5_PACKAGE_NAME}_ENABLE_THREADSAFE @HDF5_ENABLE_THREADSAFE@) set (${HDF5_PACKAGE_NAME}_ENABLE_PARALLEL @HDF5_ENABLE_PARALLEL@) -set (${HDF5_PACKAGE_NAME}_DEFAULT_API_VERSION "@DEFAULT_API_VERSION@") +set (${HDF5_PACKAGE_NAME}_DEFAULT_API_VERSION "@HDF5_DEFAULT_API_VERSION@") set (${HDF5_PACKAGE_NAME}_ENABLE_DEPRECATED_SYMBOLS @HDF5_ENABLE_DEPRECATED_SYMBOLS@) set (${HDF5_PACKAGE_NAME}_BUILD_DIMENSION_SCALES_WITH_NEW_REF @DIMENSION_SCALES_WITH_NEW_REF@) #----------------------------------------------------------------------------- diff --git a/config/cmake/scripts/HDF5options.cmake b/config/cmake/scripts/HDF5options.cmake index aedbaa19242..5ad94fd2e3a 100644 --- a/config/cmake/scripts/HDF5options.cmake +++ b/config/cmake/scripts/HDF5options.cmake @@ -32,7 +32,7 @@ #### Only build static libraries #### #set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DBUILD_SHARED_LIBS:BOOL=OFF") #### Only build shared libraries #### -#set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DONLY_SHARED_LIBS:BOOL=OFF") +#set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DHDF5_ONLY_SHARED_LIBS:BOOL=OFF") #### Add PIC option on linux/mac #### #set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DCMAKE_ANSI_CFLAGS:STRING=-fPIC") diff --git a/config/sanitizer/README.md b/config/sanitizer/README.md index 62202ffa7ec..a5ce6494a61 100644 --- a/config/sanitizer/README.md +++ b/config/sanitizer/README.md @@ -54,7 +54,7 @@ A quick rundown of the tools available, and what they do: - [MemorySanitizer](https://clang.llvm.org/docs/MemorySanitizer.html) detects uninitialized reads. - [Control Flow Integrity](https://clang.llvm.org/docs/ControlFlowIntegrity.html) is designed to detect certain forms of undefined behaviour that can potentially allow attackers to subvert the program's control flow. -These are used by declaring the `USE_SANITIZER` CMake variable as string containing any of: +These are used by declaring the `HDF5_USE_SANITIZER` CMake variable as string containing any of: - Address - Memory - MemoryWithOrigins @@ -63,7 +63,7 @@ These are used by declaring the `USE_SANITIZER` CMake variable as string contain - Leak - CFI -Multiple values are allowed, e.g. `-DUSE_SANITIZER=Address,Leak` but some sanitizers cannot be combined together, e.g.`-DUSE_SANITIZER=Address,Memory` will result in configuration error. The delimiter character is not required and `-DUSE_SANITIZER=AddressLeak` would work as well. +Multiple values are allowed, e.g. `-DHDF5_USE_SANITIZER=Address,Leak` but some sanitizers cannot be combined together, e.g.`-DHDF5_USE_SANITIZER=Address,Memory` will result in configuration error. The delimiter character is not required and `-DHDF5_USE_SANITIZER=AddressLeak` would work as well. ## Code Coverage [`code-coverage.cmake`](code-coverage.cmake) diff --git a/config/sanitizer/sanitizers.cmake b/config/sanitizer/sanitizers.cmake index dea9f099f06..fa5d1059aeb 100644 --- a/config/sanitizer/sanitizers.cmake +++ b/config/sanitizer/sanitizers.cmake @@ -13,7 +13,7 @@ # License for the specific language governing permissions and limitations under # the License. -set(USE_SANITIZER +set(HDF5_USE_SANITIZER "" CACHE STRING @@ -50,8 +50,8 @@ function(test_san_flags return_var flags) set(CMAKE_REQUIRED_QUIET "${QUIET_BACKUP}") endfunction() -message(STATUS "USE_SANITIZER=${USE_SANITIZER}, CMAKE_C_COMPILER_ID=${CMAKE_C_COMPILER_ID}") -if(USE_SANITIZER) +message(STATUS "HDF5_USE_SANITIZER=${HDF5_USE_SANITIZER}, CMAKE_C_COMPILER_ID=${CMAKE_C_COMPILER_ID}") +if(HDF5_USE_SANITIZER) if(CMAKE_C_COMPILER_ID MATCHES "IntelLLVM" OR CMAKE_C_COMPILER_ID MATCHES "[Cc]lang") set(CMAKE_EXPORT_COMPILE_COMMANDS ON) @@ -65,7 +65,7 @@ if(USE_SANITIZER) append("-O1" CMAKE_C_FLAGS CMAKE_CXX_FLAGS) endif() - if(USE_SANITIZER MATCHES "([Aa]ddress)") + if(HDF5_USE_SANITIZER MATCHES "([Aa]ddress)") # Optional: -fno-optimize-sibling-calls -fsanitize-address-use-after-scope message(STATUS "Testing with Address sanitizer") set(SANITIZER_ADDR_FLAG "-fsanitize=address") @@ -85,9 +85,9 @@ if(USE_SANITIZER) endif() endif() - if(USE_SANITIZER MATCHES "([Mm]emory([Ww]ith[Oo]rigins)?)") + if(HDF5_USE_SANITIZER MATCHES "([Mm]emory([Ww]ith[Oo]rigins)?)") set(SANITIZER_MEM_FLAG "-fsanitize=memory") - if(USE_SANITIZER MATCHES "([Mm]emory[Ww]ith[Oo]rigins)") + if(HDF5_USE_SANITIZER MATCHES "([Mm]emory[Ww]ith[Oo]rigins)") message(STATUS "Testing with MemoryWithOrigins sanitizer") append("-fno-optimize-sibling-calls -fsanitize-memory-track-origins=2" SANITIZER_MEM_FLAG) else() @@ -95,7 +95,7 @@ if(USE_SANITIZER) endif() test_san_flags(SANITIZER_MEM_AVAILABLE ${SANITIZER_MEM_FLAG}) if(SANITIZER_MEM_AVAILABLE) - if(USE_SANITIZER MATCHES "([Mm]emory[Ww]ith[Oo]rigins)") + if(HDF5_USE_SANITIZER MATCHES "([Mm]emory[Ww]ith[Oo]rigins)") message(STATUS " Building with MemoryWithOrigins sanitizer") else() message(STATUS " Building with Memory sanitizer") @@ -113,7 +113,7 @@ if(USE_SANITIZER) endif() endif() - if(USE_SANITIZER MATCHES "([Uu]ndefined)") + if(HDF5_USE_SANITIZER MATCHES "([Uu]ndefined)") message(STATUS "Testing with Undefined Behaviour sanitizer") set(SANITIZER_UB_FLAG "-fsanitize=undefined") if(EXISTS "${BLACKLIST_FILE}") @@ -132,7 +132,7 @@ if(USE_SANITIZER) endif() endif() - if(USE_SANITIZER MATCHES "([Tt]hread)") + if(HDF5_USE_SANITIZER MATCHES "([Tt]hread)") message(STATUS "Testing with Thread sanitizer") set(SANITIZER_THREAD_FLAG "-fsanitize=thread") test_san_flags(SANITIZER_THREAD_AVAILABLE ${SANITIZER_THREAD_FLAG}) @@ -148,7 +148,7 @@ if(USE_SANITIZER) endif() endif() - if(USE_SANITIZER MATCHES "([Ll]eak)") + if(HDF5_USE_SANITIZER MATCHES "([Ll]eak)") message(STATUS "Testing with Leak sanitizer") set(SANITIZER_LEAK_FLAG "-fsanitize=leak") test_san_flags(SANITIZER_LEAK_AVAILABLE ${SANITIZER_LEAK_FLAG}) @@ -164,7 +164,7 @@ if(USE_SANITIZER) endif() endif() - if(USE_SANITIZER MATCHES "([Cc][Ff][Ii])") + if(HDF5_USE_SANITIZER MATCHES "([Cc][Ff][Ii])") message(STATUS "Testing with Control Flow Integrity(CFI) sanitizer") set(SANITIZER_CFI_FLAG "-fsanitize=cfi") test_san_flags(SANITIZER_CFI_AVAILABLE ${SANITIZER_CFI_FLAG}) @@ -186,10 +186,10 @@ if(USE_SANITIZER) message(STATUS " Building with ${SANITIZER_SELECTED_FLAGS}") append("${SANITIZER_SELECTED_FLAGS}" CMAKE_C_FLAGS CMAKE_CXX_FLAGS) else() - message(FATAL_ERROR "Unsupported value of USE_SANITIZER: ${USE_SANITIZER}") + message(FATAL_ERROR "Unsupported value of HDF5_USE_SANITIZER: ${HDF5_USE_SANITIZER}") endif() elseif(MSVC) - if(USE_SANITIZER MATCHES "([Aa]ddress)") + if(HDF5_USE_SANITIZER MATCHES "([Aa]ddress)") message(STATUS "Building with Address sanitizer") append("-fsanitize=address" CMAKE_C_FLAGS CMAKE_CXX_FLAGS) @@ -197,19 +197,19 @@ if(USE_SANITIZER) append_quoteless(AFL_USE_ASAN=1 CMAKE_C_COMPILER_LAUNCHER CMAKE_CXX_COMPILER_LAUNCHER) endif() else() - message(FATAL_ERROR "This sanitizer not yet supported in the MSVC environment: ${USE_SANITIZER}") + message(FATAL_ERROR "This sanitizer not yet supported in the MSVC environment: ${HDF5_USE_SANITIZER}") endif() else() - message(FATAL_ERROR "USE_SANITIZER is not supported on this platform.") + message(FATAL_ERROR "HDF5_USE_SANITIZER is not supported on this platform.") endif() elseif(MSVC) - if(USE_SANITIZER MATCHES "([Aa]ddress)") + if(HDF5_USE_SANITIZER MATCHES "([Aa]ddress)") message(STATUS "Building with Address sanitizer") append("/fsanitize=address" CMAKE_C_FLAGS CMAKE_CXX_FLAGS) else() - message(FATAL_ERROR "This sanitizer not yet supported in the MSVC environment: ${USE_SANITIZER}") + message(FATAL_ERROR "This sanitizer not yet supported in the MSVC environment: ${HDF5_USE_SANITIZER}") endif() else() - message(FATAL_ERROR "USE_SANITIZER is not supported on this platform.") + message(FATAL_ERROR "HDF5_USE_SANITIZER is not supported on this platform.") endif() endif() diff --git a/doc/cmake-vols-fetchcontent.md b/doc/cmake-vols-fetchcontent.md index ff0591311c4..f7b395dec7b 100644 --- a/doc/cmake-vols-fetchcontent.md +++ b/doc/cmake-vols-fetchcontent.md @@ -145,7 +145,7 @@ would typically be passed when building HDF5, such as `CMAKE_INSTALL_PREFIX`, cmake [hdf5 options] -DHDF5_ENABLE_THREADSAFE=ON -DHDF5_ENABLE_PARALLEL=ON - -DALLOW_UNSUPPORTED=ON + -DHDF5_ALLOW_UNSUPPORTED=ON -DHDF5_TEST_API=ON -DHDF5_VOL_ALLOW_EXTERNAL="GIT" -DHDF5_VOL_URL01=https://github.com/hpc-io/vol-async.git diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt index 6db1b29cc6f..0b33946767b 100644 --- a/release_docs/INSTALL_CMake.txt +++ b/release_docs/INSTALL_CMake.txt @@ -817,7 +817,7 @@ BUILD_STATIC_LIBS "Build Static Libraries" ON BUILD_STATIC_EXECS "Build Static Executables" OFF BUILD_TESTING "Build HDF5 Unit Testing" ON if (WINDOWS) - DISABLE_PDB_FILES "Do not install PDB files" OFF + HDF5_DISABLE_PDB_FILES "Do not install PDB files" OFF ---------------- HDF5 Build Options ---------------------------------------- HDF5_BUILD_CPP_LIB "Build HDF5 C++ Library" OFF @@ -855,8 +855,8 @@ HDF5_INSTALL_DATA_DIR "share" HDF5_INSTALL_DOC_DIR "HDF5_INSTALL_DATA_DIR/doc/hdf5" ---------------- HDF5 Advanced Options --------------------- -ONLY_SHARED_LIBS "Only Build Shared Libraries" OFF -ALLOW_UNSUPPORTED "Allow unsupported combinations of configure options" OFF +HDF5_ONLY_SHARED_LIBS "Only Build Shared Libraries" OFF +HDF5_ALLOW_UNSUPPORTED "Allow unsupported combinations of configure options" OFF HDF5_ENABLE_PARALLEL "Enable parallel build (requires MPI)" OFF HDF5_ENABLE_THREADSAFE "Enable Threadsafety" OFF HDF5_DIMENSION_SCALES_NEW_REF "Use new-style references with dimension scale APIs" OFF @@ -888,7 +888,7 @@ HDF5_STRICT_FORMAT_CHECKS "Whether to perform strict file format checks" 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 -DEFAULT_API_VERSION "Enable default API (v16, v18, v110, v112, v114, v116, v118)" "v118" +HDF5_DEFAULT_API_VERSION "Enable default API (v16, v18, v110, v112, v114, v116, v118)" "v118" HDF5_USE_FOLDERS "Enable folder grouping of projects in IDEs." ON HDF5_MSVC_NAMING_CONVENTION "Use MSVC Naming conventions for Shared Libraries" OFF HDF5_MINGW_STATIC_GCC_LIBS "Statically link libgcc/libstdc++" OFF @@ -898,10 +898,10 @@ if (CMAKE_BUILD_TYPE MATCHES Debug) HDF5_ENABLE_INSTRUMENT "Instrument The library" OFF if (HDF5_BUILD_FORTRAN) 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 + 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_ENABLE_ANALYZER_TOOLS "enable the use of Clang tools" OFF HDF5_ENABLE_SANITIZERS "execute the Clang sanitizer" OFF @@ -933,7 +933,7 @@ if (BUILD_TESTING) 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 + HDF5_TEST_SHELL_SCRIPTS "Enable shell script tests" ON HDF5_DISABLE_TESTS_REGEX "Regex pattern to set execution of specific tests to DISABLED" "" HDF5_USING_ANALYSIS_TOOL "Indicate that an analysis checker is used" ON ---------------- External Library Options --------------------- @@ -981,14 +981,14 @@ NOTE: ---------------- Unsupported Library Options --------------------- The threadsafe, C++ and Java interfaces are not compatible with the HDF5_ENABLE_PARALLEL option. - Unless ALLOW_UNSUPPORTED has been specified, + Unless HDF5_ALLOW_UNSUPPORTED has been specified, the following options must be disabled: HDF5_ENABLE_THREADSAFE, HDF5_BUILD_CPP_LIB, HDF5_BUILD_JAVA The high-level, C++, Fortran and Java interfaces are not compatible with the HDF5_ENABLE_THREADSAFE option because the lock is not hoisted into the higher-level API calls. - Unless ALLOW_UNSUPPORTED has been specified, + Unless HDF5_ALLOW_UNSUPPORTED has been specified, the following options must be disabled: HDF5_BUILD_HL_LIB, HDF5_BUILD_CPP_LIB, HDF5_BUILD_FORTRAN, HDF5_BUILD_JAVA diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt index 8442839e2fb..7e5880ea590 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -47,6 +47,15 @@ New Features Configuration: ------------- + - Renamed remaining HDF5 library CMake options except for CMake BUILD* variables + + DEFAULT_API_VERSION to HDF5_DEFAULT_API_VERSION + DISABLE_PDB_FILES to HDF5_DISABLE_PDB_FILES + ONLY_SHARED_LIBS to HDF5_ONLY_SHARED_LIBS + ALLOW_UNSUPPORTED to HDF5_ALLOW_UNSUPPORTED + TEST_SHELL_SCRIPTS to HDF5_TEST_SHELL_SCRIPTS + + All other HDF5 library CMake options are prefixed with HDF5_ - bin/cmakehdf5 has been removed This was an unsupported build script that made building HDF5 via CMake diff --git a/src/H5build_settings.cmake.c.in b/src/H5build_settings.cmake.c.in index acb5c5bb169..6dac78d27b1 100644 --- a/src/H5build_settings.cmake.c.in +++ b/src/H5build_settings.cmake.c.in @@ -95,7 +95,7 @@ const char H5build_settings[]= " Build HDF5 Tools: @HDF5_BUILD_TOOLS@\n" " Build GIF Tools: @HDF5_BUILD_HL_GIF_TOOLS@\n" " Threadsafety: @HDF5_ENABLE_THREADSAFE@\n" - " Default API mapping: @DEFAULT_API_VERSION@\n" + " Default API mapping: @HDF5_DEFAULT_API_VERSION@\n" " With deprecated public symbols: @HDF5_ENABLE_DEPRECATED_SYMBOLS@\n" " I/O filters (external): @EXTERNAL_FILTERS@\n" " _Float16 support: @HDF5_ENABLE_NONSTANDARD_FEATURE_FLOAT16@\n" diff --git a/src/libhdf5.settings.cmake.in b/src/libhdf5.settings.cmake.in index 02d1796a0b4..2f9b5f5c960 100644 --- a/src/libhdf5.settings.cmake.in +++ b/src/libhdf5.settings.cmake.in @@ -76,7 +76,7 @@ Dimension scales w/ new references: @DIMENSION_SCALES_WITH_NEW_REF@ Build GIF Tools: @HDF5_BUILD_HL_GIF_TOOLS@ Threads: @HDF5_ENABLE_THREADS@ Threadsafety: @HDF5_ENABLE_THREADSAFE@ - Default API mapping: @DEFAULT_API_VERSION@ + Default API mapping: @HDF5_DEFAULT_API_VERSION@ With deprecated public symbols: @HDF5_ENABLE_DEPRECATED_SYMBOLS@ I/O filters (external): @EXTERNAL_FILTERS@ _Float16 support: @HDF5_ENABLE_NONSTANDARD_FEATURE_FLOAT16@ diff --git a/test/CMakeTests.cmake b/test/CMakeTests.cmake index 036b54798bc..37755a8551a 100644 --- a/test/CMakeTests.cmake +++ b/test/CMakeTests.cmake @@ -784,7 +784,7 @@ if ("H5TEST-err_compat" MATCHES "${HDF5_DISABLE_TESTS_REGEX}") endif () #-- Adding test for error_test -if (DEFAULT_API_VERSION MATCHES "v16" OR MINGW) +if (HDF5_DEFAULT_API_VERSION MATCHES "v16" OR MINGW) add_test (NAME H5TEST-error_test COMMAND "${CMAKE_COMMAND}" -D "TEST_EMULATOR=${CMAKE_CROSSCOMPILING_EMULATOR}" -D "TEST_PROGRAM=$" @@ -914,8 +914,8 @@ if (BUILD_SHARED_LIBS) endif () endif () -option (TEST_SHELL_SCRIPTS "Enable shell script tests" ON) -if (TEST_SHELL_SCRIPTS) +option (HDF5_TEST_SHELL_SCRIPTS "Enable shell script tests" ON) +if (HDF5_TEST_SHELL_SCRIPTS) include (ShellTests.cmake) endif()