mirrors/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2026-09-25 04:09:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve HDF5_BUILD_PARALLEL_TOOLS docs and MFU not-found message (#6428)

Browse Source 
* cmake: improve HDF5_BUILD_PARALLEL_TOOLS documentation and MFU error message

The option description for HDF5_BUILD_PARALLEL_TOOLS was too terse to be
useful — it did not mention the required MFU, CIRCLE, or DTCMP external
libraries, nor that HDF5_ENABLE_PARALLEL must also be ON. Expand it with
the dependency list and a link to the mpiFileUtils project.

- CMakeBuildOptions.cmake: rephrase HDF5_BUILD_PARALLEL_TOOLS description
  to "Build MPI-enabled HDF5 tools" (shorter, forward-compatible)
This commit is contained in:
Scot Breitenfeld
2026-06-03 14:15:44 -05:00
committed by GitHub
parent 71b4aba68d
commit a957dd480d
4 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CMakeBuildOptions.cmake
+1 -1
View File
@@ -73,7 +73,7 @@ mark_as_advanced (HDF5_ENABLE_MAP_API)
option (HDF5_BUILD_DOC "Build documentation" OFF)
option (HDF5_BUILD_PARALLEL_TOOLS "Build Parallel HDF5 Tools" OFF)
option (HDF5_BUILD_PARALLEL_TOOLS "Build MPI-enabled HDF5 tools" OFF)
mark_as_advanced (HDF5_BUILD_PARALLEL_TOOLS)
option (HDF5_BUILD_TOOLS "Build HDF5 Tools" ON)
config/cmake/FindMFU.cmake
+7 -9
View File
@@ -85,14 +85,12 @@ endif()
# Report the results.
if (NOT MFU_FOUND)
set (MFU_DIR_MESSAGE
"Mfu was not found. Make sure MFU_LIBRARY and MFU_INCLUDE_DIR are set or set the MFU_INSTALL environment variable."
message (FATAL_ERROR "MFU (mpiFileUtils) was not found. "
"MFU is an HPC parallel file utilities library (https://github.com/hpc/mpifileutils). "
"Set the MFU_ROOT environment variable to the install prefix (export MFU_ROOT=<path>), "
"or set MFU_LIBRARY and MFU_INCLUDE_DIR explicitly. "
"Note: HDF5_BUILD_PARALLEL_TOOLS also requires CIRCLE (libcircle, https://github.com/hpc/libcircle) "
"and DTCMP (https://github.com/hpc/dtcmp), which are dependencies of mpiFileUtils and "
"are expected to be installed under the same MFU_ROOT prefix."
)
if (NOT MFU_FIND_QUIETLY)
message (VERBOSE "${MFU_DIR_MESSAGE}")
else ()
if (MFU_FIND_REQUIRED)
message (FATAL_ERROR "MFU was NOT found and is required.")
endif ()
endif ()
endif ()
docs/AutotoolsToCMakeOptions.md
+1 -1
View File
@@ -59,7 +59,7 @@ The table below shows the equivalent CMake build options that match those from A
| tests[Compile the HDF5 tests [default=yes]] | BUILD_TESTING "Build HDF5 Unit Testing" [ON] | |
| test-express[Set HDF5 testing intensity level (0-3) [0 = exhaustive testing; 3 = quicker testing; default=3] | HDF_TEST_EXPRESS "Control testing framework (0-3)" ["3"] | |
| tools[Compile the HDF5 tools [default=yes]] | HDF5_BUILD_TOOLS "Build HDF5 Tools" [ON] | |
| parallel-tools[Enable building parallel tools. [default=no]] | HDF5_BUILD_PARALLEL_TOOLS "Build Parallel HDF5 Tools" [OFF] | |
| parallel-tools[Enable building parallel tools. [default=no]] | HDF5_BUILD_PARALLEL_TOOLS "Build MPI-enabled HDF5 tools" [OFF] | |
| **Autotools Doc Options** | **CMake Doc Options** | **Notes** |
| doxygen[Compile the HDF5 doxygen files [default=no]] | HDF5_BUILD_DOC "Build documentation" [OFF] | |
| doxygen-errors[Error on HDF5 doxygen warnings [default=no]] | HDF5_ENABLE_DOXY_WARNINGS "Enable fail if doxygen parsing has warnings." [OFF] | |
docs/INSTALL_CMake_options.md
+1 -1
View File
@@ -195,7 +195,7 @@ These are options which are specific to parallel HDF5.
|:-------------|:-----|:--------|:------------|
| `HDF5_ENABLE_PARALLEL` | `BOOL` | `OFF` | If `ON`, enables building of parallel HDF5. Requires an MPI implementation of at least the [MPI 3.0 standard](https://www.mpi-forum.org/docs/mpi-3.0/mpi30-report.pdf). |
| `HDF5_ENABLE_SUBFILING_VFD` | `BOOL` | `OFF` | If `ON`, enables building of the HDF5 [Subfiling VFD](https://github.com/HDFGroup/hdf5doc/blob/master/RFCs/HDF5_Library/VFD_Subfiling/user_guide/HDF5_Subfiling_VFD_User_s_Guide.pdf). Requires C11 threads, Win32 threads or Pthreads. |
| `HDF5_BUILD_PARALLEL_TOOLS` | `BOOL` | `OFF` | If `ON`, enables building of parallel HDF5 tools. Currently experimental. |
| `HDF5_BUILD_PARALLEL_TOOLS` | `BOOL` | `OFF` | If `ON`, enables building of MPI-enabled HDF5 tools. Currently experimental. |
| `MPI_C_COMPILER` | `FILEPATH` | Varies | Path to the program to be used for compiling MPI C source code. Usually auto-detected by CMake. |
| `MPIEXEC_EXECUTABLE` | `FILEPATH` | Varies | Path to the program to be used for running MPI programs. Usually auto-detected by CMake. |
| `MPIEXEC_MAX_NUMPROCS` | `STRING` | Varies | Maximum number of MPI processes to use when running MPI programs. Usually auto-detected by CMake. |