echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

FindHDF5: docs

Browse Source 
The docs referred to deprecated variables and HDF5_ROOT, which is
implicit for every Find*.
This commit is contained in:
Michael Hirsch, Ph.D 2020-02-11 11:08:59 -05:00
parent 6e14fe4d1f
commit 88cffab75f
No known key found for this signature in database
GPG Key ID: 6D23CDADAB0294F9
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Modules/FindHDF5.cmake
View File

@ -19,9 +19,12 @@ The module will optionally accept the ``COMPONENTS`` argument. If no
``COMPONENTS`` are specified, then the find module will default to finding ``COMPONENTS`` are specified, then the find module will default to finding
only the ``HDF5`` C library. If one or more ``COMPONENTS`` are specified, the only the ``HDF5`` C library. If one or more ``COMPONENTS`` are specified, the
module will attempt to find the language bindings for the specified module will attempt to find the language bindings for the specified
components. The only valid components are ``C``, ``CXX``, ``Fortran``, ``HL``, components. The valid components are ``C``, ``CXX``, ``Fortran``, ``HL``.
and ``Fortran_HL``. If the ``COMPONENTS`` argument is not given, the module will ``HL`` refers to the "high-level" HDF5 functions for C and Fortran.
If the ``COMPONENTS`` argument is not given, the module will
attempt to find only the C bindings. attempt to find only the C bindings.
For example, to use Fortran HDF5 and HDF5-HL functions, do:
``find_package(HDF5 COMPONENTS Fortran HL)``.
This module will read the variable This module will read the variable
``HDF5_USE_STATIC_LIBRARIES`` to determine whether or not to prefer a ``HDF5_USE_STATIC_LIBRARIES`` to determine whether or not to prefer a
@ -29,11 +32,6 @@ static link to a dynamic link for ``HDF5`` and all of it's dependencies.
To use this feature, make sure that the ``HDF5_USE_STATIC_LIBRARIES`` To use this feature, make sure that the ``HDF5_USE_STATIC_LIBRARIES``
variable is set before the call to find_package. variable is set before the call to find_package.
To provide the module with a hint about where to find your ``HDF5``
installation, you can set the environment variable ``HDF5_ROOT``. The
Find module will then look in this path when searching for ``HDF5``
executables, paths, and libraries.
Both the serial and parallel ``HDF5`` wrappers are considered and the first Both the serial and parallel ``HDF5`` wrappers are considered and the first
directory to contain either one will be used. In the event that both appear directory to contain either one will be used. In the event that both appear
in the same directory the serial version is preferentially selected. This in the same directory the serial version is preferentially selected. This
@ -115,10 +113,10 @@ also be defined. With all components enabled, the following variables will be d
Hints Hints
^^^^^ ^^^^^
The following variable can be set to guide the search for HDF5 libraries and includes: The following variables can be set to guide the search for HDF5 libraries and includes:
``HDF5_ROOT`` ``HDF5_PREFER_PARALLEL``
Specify the path to the HDF5 installation to use. set ``true`` to prefer parallel HDF5 (by default, serial is preferred)
``HDF5_FIND_DEBUG`` ``HDF5_FIND_DEBUG``
Set ``true`` to get extra debugging output. Set ``true`` to get extra debugging output.