summaryrefslogtreecommitdiffstats
path: root/release_docs/USING_HDF5_CMake.txt
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2022-03-14 12:14:44 (GMT)
committerGitHub <noreply@github.com>2022-03-14 12:14:44 (GMT)
commitff3abc72712dbd677c141c9443a366677ef0b2cf (patch)
tree1629409be44a3577fb137df75169a3f38eff9412 /release_docs/USING_HDF5_CMake.txt
parentdc858321b60d7a7b4f3ea31b2e96933624c6cd2a (diff)
downloadhdf5-ff3abc72712dbd677c141c9443a366677ef0b2cf.zip
hdf5-ff3abc72712dbd677c141c9443a366677ef0b2cf.tar.gz
hdf5-ff3abc72712dbd677c141c9443a366677ef0b2cf.tar.bz2
1.8 Update HDF5_ROOT usage (#1488)
Diffstat (limited to 'release_docs/USING_HDF5_CMake.txt')
-rw-r--r--release_docs/USING_HDF5_CMake.txt27
1 files changed, 15 insertions, 12 deletions
diff --git a/release_docs/USING_HDF5_CMake.txt b/release_docs/USING_HDF5_CMake.txt
index d11410c..0efb2a1 100644
--- a/release_docs/USING_HDF5_CMake.txt
+++ b/release_docs/USING_HDF5_CMake.txt
@@ -29,42 +29,45 @@ Notes: This short instruction is written for users who want to quickly
of using a ctest script for building and testing. See
INSTALL_CMake.txt for more information.
+ 4. See https://cmake.org/cmake/help/latest/command/find_package.html
+ for more information on the CMake "Config Mode Search Procedure".
========================================================================
I. Preconditions
========================================================================
- 1. We suggest you obtain the latest CMake for windows from the Kitware
+ 1. We suggest you obtain the latest CMake for your platform from the Kitware
web site. The HDF5 1.8.x product requires a minimum CMake version
- of 3.12.
+ of 3.12. If you are using VS2019, the minimum version is 3.15.
2. You have installed the HDF5 library built with CMake, by executing
the HDF Install Utility (the *.msi file in the binary package for
- Windows). You can obtain pre-built binaries from The HDF Group's website at
- www.hdfgroup.org.
+ Windows or the *.sh on Linux). You can obtain pre-built binaries
+ from The HDF Group's website at www.hdfgroup.org.
- 3. Set the environment variable HDF5_DIR to the installed location of
- the config files for HDF5.
+ 3. Set the HDF5_ROOT CMake variable, -DHDF5_ROOT=<install_path>
+ or environment variable, set(ENV{HDF5_ROOT} "<install_path>")
+ to the installed location of HDF5.
On Windows:
- HDF5_DIR=C:/Program Files/HDF_Group/HDF5/1.10.x/cmake
+ HDF5_ROOT=C:/Program Files/HDF_Group/HDF5/1.8.x/
On unix:
- HDF5_DIR=<install root folder>/HDF_Group/HDF5/1.10.x/cmake
+ HDF5_ROOT=<install root folder>/HDF_Group/HDF5/1.8.x/
If you are using shared libraries, you may need to add to the path
environment variable. Set the path environment variable to the
installed location of the library files for HDF5.
On Windows (*.dll):
- PATH=%PATH%;C:/Program Files/HDF_Group/HDF5/1.10.x/bin
+ PATH=%PATH%;C:/Program Files/HDF_Group/HDF5/1.8.x/bin
On unix (*.so):
- LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<install root folder>/HDF_Group/HDF5/1.10.x/lib
+ LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<install root folder>/HDF_Group/HDF5/1.8.x/lib
If you are using filter plugin libraries, you will need to set the
HDF5_PLUGIN_PATH environment variable.
On Windows:
- HDF5_PLUGIN_PATH=C:/Program Files/HDF_Group/HDF5/1.10.x/lib/plugin
+ HDF5_PLUGIN_PATH=C:/Program Files/HDF_Group/HDF5/1.8.x/lib/plugin
On unix:
- HDF5_PLUGIN_PATH=<install root folder>/HDF_Group/HDF5/1.10.x/lib/plugin
+ HDF5_PLUGIN_PATH=<install root folder>/HDF_Group/HDF5/1.8.x/lib/plugin
(Note there are no quote characters used on Windows and all platforms
use forward slashes)