Change option to mean what it does

HDFGroup · Jan 29, 2025 · 17690f6 · 17690f6
1 parent 7200ff1
commit 17690f6
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/CMakeFilters.cmake b/CMakeFilters.cmake
@@ -88,15 +88,15 @@ endif ()
 if (HDF5_ENABLE_ZLIB_SUPPORT)
   if (NOT H5_ZLIB_HEADER)
     if (NOT ZLIB_USE_EXTERNAL)
-      option (HDF5_DEFAULT_ZLIB_SYSTEM "Use the default system installed ZLIB" ON)
+      option (HDF5_MODULE_MODE_ZLIB "Find the default system ZLIB in module mode" ON)
       if (HDF5_USE_ZLIB_NG)
         set (PACKAGE_NAME ${ZLIBNG_PACKAGE_NAME}${HDF_PACKAGE_EXT})
       else ()
         set (PACKAGE_NAME ${ZLIB_PACKAGE_NAME}${HDF_PACKAGE_EXT})
       endif ()
       set(ZLIB_FOUND FALSE)
       message (VERBOSE "Filter HDF5_ZLIB package name:${PACKAGE_NAME}")
-      if (HDF5_DEFAULT_ZLIB_SYSTEM)
+      if (HDF5_MODULE_MODE_ZLIB)
         # Expect that the default shared library is expected with FindZLIB.cmake
         find_package (ZLIB MODULE)
       else ()

diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
@@ -877,7 +877,7 @@ if (BUILD_TESTING)
 HDF5_ALLOW_EXTERNAL_SUPPORT "Allow External Library Building (NO GIT TGZ)"       "NO"
 HDF5_ENABLE_PLUGIN_SUPPORT  "Enable PLUGIN Filters"                              OFF
 HDF5_ENABLE_SZIP_SUPPORT    "Use SZip Filter"                                    OFF
-HDF5_DEFAULT_ZLIB_SYSTEM    "Use the default system installed ZLIB"              ON
+HDF5_MODULE_MODE_ZLIB       "Find the default system ZLIB in module mode"        ON
 HDF5_ENABLE_ZLIB_SUPPORT    "Enable Zlib Filters"                                OFF
 
 if (HDF5_USE_ZLIB_NG)

diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
@@ -568,7 +568,7 @@ Bug Fixes since HDF5-2.0.0 release
     - When using a system installed zlib library, the shared library is expected to
       be found in the system library path.
 
-      Setting the HDF5_DEFAULT_ZLIB_SYSTEM option to OFF, the system installed zlib,
+      Setting the HDF5_MODULE_MODE_ZLIB option to OFF, the system installed zlib,
       or an alternate installed zlib library, is expected to have a correct
       zlib-config.cmake file.