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

Rename the HDF5Examples build option prefix (#5906)

Browse Source 
Renamed all HDF5 examples build options from H5EX_* to H5EXAMPLE_* to better distinguish them from library options when building examples alongside the library.

Updated all CMake files, including:
Main examples CMakeLists.txt files
CMake configuration files in config/ directory
CMake preset files
Updated documentation files to reflect new option names
This commit is contained in:
Allen Byrne
2025-10-08 15:53:44 -05:00
committed by GitHub
parent ac169ed3e8
commit 701b46daed
38 changed files with 453 additions and 450 deletions
Download Patch File Download Diff File Expand all files Collapse all files
HDF5Examples/Using_CMake.txt
+17 -17
View File
@@ -184,17 +184,17 @@ II. Building HDF5 Examples with CMake
* ... [Win32, x64, ARM, ARM64]
<options> is:
* H5EX_BUILD_TESTING:BOOL=ON
* H5EXAMPLE_BUILD_TESTING:BOOL=ON
* BUILD_SHARED_LIBS:BOOL=[ON | OFF]
* H5EX_BUILD_FORTRAN:BOOL=[ON | OFF]
* H5EX_BUILD_JAVA:BOOL=[ON | OFF]
* H5EXAMPLE_BUILD_FORTRAN:BOOL=[ON | OFF]
* H5EXAMPLE_BUILD_JAVA:BOOL=[ON | OFF]
if the hdf5 library was built with a namespace (i.e. "hdf5::") add:
-D HDF5_NAMESPACE:STRING=hdf5::
Example command line on Windows in c:\MyHDFstuff\hdf5ex\build directory:
cmake -G "Visual Studio 17 2022" -DH5EX_BUILD_TESTING:BOOL=ON -DBUILD_SHARED_LIBS:BOOL=ON ..
cmake -G "Visual Studio 17 2022" -DH5EXAMPLE_BUILD_TESTING:BOOL=ON -DBUILD_SHARED_LIBS:BOOL=ON ..
C. Build HDF5 examples
@@ -233,7 +233,7 @@ II. Building HDF5 Examples with CMake
export HDF5_HOME=<root_path>/HDF_Group/HDF5/2.0.0
cd <example_path_root>/HDF5Examples/
sh ./test-pc.sh <example_path_root>/HDF5Examples/ <example_path_root>/H5EX_BUILD/ .
sh ./test-pc.sh <example_path_root>/HDF5Examples/ <example_path_root>/H5EXAMPLE_BUILD/ .
5. The files that support building with CMake are all of the files in the
config/cmake folder, the CMakeLists.txt files in each source folder, and
@@ -255,12 +255,12 @@ III. Defaults in the CMakePresets.json file
#### "BUILD_SHARED_LIBS": "ON",
#### "USE_SHARED_LIBS": "ON"
#### "CMAKE_BUILD_TYPE": "RelWithDebInfo"
#### "H5EX_BUILD_FORTRAN": "ON"
#### "H5EX_BUILD_CXX": "ON"
#### "H5EX_BUILD_JAVA": "ON"
#### "H5EXAMPLE_BUILD_FORTRAN": "ON"
#### "H5EXAMPLE_BUILD_CXX": "ON"
#### "H5EXAMPLE_BUILD_JAVA": "ON"
#### "HDF5_NAMESPACE": {"type": "STRING", "value": "hdf5::"},
#### "HDF5_PACKAGE_NAME": {"type": "STRING", "value": "hdf5"},
#### "H5EX_BUILD_TESTING": "ON"
#### "H5EXAMPLE_BUILD_TESTING": "ON"
========================================================================
@@ -269,14 +269,14 @@ IV. Defaults in the HDF5_Examples_options.cmake file
#### DEFAULT:
#### BUILD_SHARED_LIBS:BOOL=OFF
#### H5EX_BUILD_C:BOOL=ON
#### H5EX_BUILD_HL:BOOL=OFF
#### H5EX_BUILD_CXX:BOOL=OFF
#### H5EX_BUILD_FORTRAN:BOOL=OFF
#### H5EX_BUILD_JAVA:BOOL=OFF
#### H5EX_BUILD_FILTERS:BOOL=OFF
#### H5EX_BUILD_TESTING:BOOL=OFF
#### H5EX_ENABLE_PARALLEL:BOOL=OFF
#### H5EXAMPLE_BUILD_C:BOOL=ON
#### H5EXAMPLE_BUILD_HL:BOOL=OFF
#### H5EXAMPLE_BUILD_CXX:BOOL=OFF
#### H5EXAMPLE_BUILD_FORTRAN:BOOL=OFF
#### H5EXAMPLE_BUILD_JAVA:BOOL=OFF
#### H5EXAMPLE_BUILD_FILTERS:BOOL=OFF
#### H5EXAMPLE_BUILD_TESTING:BOOL=OFF
#### H5EXAMPLE_ENABLE_PARALLEL:BOOL=OFF
************************************************************************