Update install texts (#4010)

* Update INSTALL_CMake.txt as necessary * Update remaining docs that use HDF5_USE_GNU_DIRS * Update options in HDFMacros in HDF5Examples
HDFGroup · Feb 14, 2024 · 14ed93e · 14ed93e
1 parent be956ea
commit 14ed93e
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 28 deletions.
diff --git a/HDF5Examples/config/cmake/HDFMacros.cmake b/HDF5Examples/config/cmake/HDFMacros.cmake
@@ -90,7 +90,7 @@ macro (HDFTEST_COPY_FILE src dest target)
 endmacro ()
 
 macro (HDF_DIR_PATHS package_prefix)
-  option (H5EX_USE_GNU_DIRS "TRUE to use GNU Coding Standard install directory variables, FALSE to use historical settings" FALSE)
+	option (H5EX_USE_GNU_DIRS "ON to use GNU Coding Standard install directory variables, OFF to use historical settings" OFF)
   if (H5EX_USE_GNU_DIRS)
     include(GNUInstallDirs)
     if (NOT ${package_prefix}_INSTALL_BIN_DIR)
@@ -121,7 +121,7 @@ macro (HDF_DIR_PATHS package_prefix)
   endif ()
 
   if (APPLE)
-    option (${package_prefix}_BUILD_FRAMEWORKS "TRUE to build as frameworks libraries, FALSE to build according to BUILD_SHARED_LIBS" FALSE)
+	  option (${package_prefix}_BUILD_FRAMEWORKS "ON to build as frameworks libraries, OFF to build according to BUILD_SHARED_LIBS" OFF)
   endif ()
 
   if (NOT ${package_prefix}_INSTALL_BIN_DIR)
@@ -170,10 +170,10 @@ macro (HDF_DIR_PATHS package_prefix)
   message(STATUS "Final: ${${package_prefix}_INSTALL_DOC_DIR}")
 
   # Always use full RPATH, i.e. don't skip the full RPATH for the build tree
-  set (CMAKE_SKIP_BUILD_RPATH  FALSE)
+  set (CMAKE_SKIP_BUILD_RPATH  OFF)
   # when building, don't use the install RPATH already
   # (but later on when installing)
-  set (CMAKE_INSTALL_RPATH_USE_LINK_PATH  FALSE)
+  set (CMAKE_INSTALL_RPATH_USE_LINK_PATH  OFF)
   # add the automatically determined parts of the RPATH
   # which point to directories outside the build tree to the install RPATH
   set (CMAKE_BUILD_WITH_INSTALL_RPATH ON)

diff --git a/config/cmake/HDF5ExampleCache.cmake b/config/cmake/HDF5ExampleCache.cmake
@@ -14,7 +14,7 @@ set (HDF_BUILD_CPP_LIB ${HDF5_BUILD_CPP_LIB} CACHE BOOL "Build HDF5 C++ Library"
 set (HDF_BUILD_HL_LIB ${HDF5_BUILD_HL_LIB} CACHE BOOL "Build HIGH Level examples" FORCE)
 set (HDF_ENABLE_THREADSAFE ${HDF5_ENABLE_THREADSAFE} CACHE BOOL "Enable examples thread-safety" FORCE)
 set (HDF_ENABLE_PARALLEL ${HDF5_ENABLE_PARALLEL} CACHE BOOL "Enable examples parallel build (requires MPI)" FORCE)
-set (H5EX_USE_GNU_DIRS ${HDF5_USE_GNU_DIRS} CACHE BOOL "TRUE to use GNU Coding Standard install directory variables, FALSE to use historical settings" FORCE)
+set (H5EX_USE_GNU_DIRS ${HDF5_USE_GNU_DIRS} CACHE BOOL "ON to use GNU Coding Standard install directory variables, OFF to use historical settings" FORCE)
 
 #preset HDF5 cache vars to this projects libraries instead of searching
 set (H5EX_HDF5_HEADER "H5pubconf.h" CACHE STRING "Name of HDF5 header" FORCE)

diff --git a/config/cmake/HDF5PluginCache.cmake b/config/cmake/HDF5PluginCache.cmake
@@ -39,4 +39,4 @@ set (H5PL_TGZ_NAME "${PLUGIN_TGZ_NAME}" CACHE STRING "Use plugins from compresse
 set (PL_PACKAGE_NAME "${PLUGIN_PACKAGE_NAME}" CACHE STRING "Name of plugins package" FORCE)
 set (H5PL_CPACK_ENABLE OFF CACHE BOOL "Enable CPack include and components" FORCE)
 
-set (H5PL_USE_GNU_DIRS ${HDF5_USE_GNU_DIRS} CACHE BOOL "TRUE to use GNU Coding Standard install directory variables" FORCE)
+set (H5PL_USE_GNU_DIRS ${HDF5_USE_GNU_DIRS} CACHE BOOL "ON to use GNU Coding Standard install directory variables, OFF to use historical settings" FORCE)
diff --git a/config/cmake/HDFMacros.cmake b/config/cmake/HDFMacros.cmake
@@ -369,7 +369,7 @@ macro (HDFTEST_COPY_FILE src dest target)
 endmacro ()
 
 macro (HDF_DIR_PATHS package_prefix)
-  option (HDF5_USE_GNU_DIRS "TRUE to use GNU Coding Standard install directory variables, FALSE to use historical settings" FALSE)
+  option (HDF5_USE_GNU_DIRS "ON to use GNU Coding Standard install directory variables, OFF to use historical settings" OFF)
   if (HDF5_USE_GNU_DIRS)
     include(GNUInstallDirs)
     if (NOT ${package_prefix}_INSTALL_BIN_DIR)
@@ -400,7 +400,7 @@ macro (HDF_DIR_PATHS package_prefix)
   endif ()
 
   if (APPLE)
-    option (${package_prefix}_BUILD_FRAMEWORKS "TRUE to build as frameworks libraries, FALSE to build according to BUILD_SHARED_LIBS" FALSE)
+    option (${package_prefix}_BUILD_FRAMEWORKS "ON to build as frameworks libraries, OFF to build according to BUILD_SHARED_LIBS" OFF)
   endif ()
 
   if (NOT ${package_prefix}_INSTALL_BIN_DIR)
@@ -449,10 +449,10 @@ macro (HDF_DIR_PATHS package_prefix)
   message(STATUS "Final: ${${package_prefix}_INSTALL_DOC_DIR}")
 
   # Always use full RPATH, i.e. don't skip the full RPATH for the build tree
-  set (CMAKE_SKIP_BUILD_RPATH  FALSE)
+  set (CMAKE_SKIP_BUILD_RPATH  OFF)
   # when building, don't use the install RPATH already
   # (but later on when installing)
-  set (CMAKE_INSTALL_RPATH_USE_LINK_PATH  FALSE)
+  set (CMAKE_INSTALL_RPATH_USE_LINK_PATH  OFF)
   # add the automatically determined parts of the RPATH
   # which point to directories outside the build tree to the install RPATH
   set (CMAKE_BUILD_WITH_INSTALL_RPATH ON)

diff --git a/release_docs/INSTALL → release_docs/INSTALL_Auto.txt b/release_docs/INSTALL → release_docs/INSTALL_Auto.txt
@@ -15,7 +15,6 @@ CONTENTS
 
         2. Quick installation
         2.1. Windows
-        2.2. RedStorm (Cray XT3)
 
         3. HDF5 dependencies
         3.1. Zlib
@@ -84,13 +83,6 @@ CONTENTS
         Users of Microsoft Windows should see the INSTALL_Windows files for
         detailed instructions.
 
-2.2. RedStorm (Cray XT3)
-        Users of the Red Storm machine, after reading this file, should read
-        the Red Storm section in the INSTALL_parallel file for specific
-        instructions for the Red Storm machine.  The same instructions would
-        probably work for other Cray XT3 systems, but they have not been
-        verified.
-
 
 3. HDF5 dependencies
 3.1. Zlib

diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
@@ -788,13 +788,14 @@ if (WINDOWS)
   DISABLE_PDB_FILES "Do not install PDB files" OFF
 
 ---------------- HDF5 Build Options ---------------------
-HDF5_BUILD_CPP_LIB      "Build HDF5 C++ Library"          OFF
-HDF5_BUILD_EXAMPLES     "Build HDF5 Library Examples"     ON
-HDF5_BUILD_FORTRAN      "Build FORTRAN support"           OFF
-HDF5_BUILD_JAVA         "Build JAVA support"              OFF
-HDF5_BUILD_HL_LIB       "Build HIGH Level HDF5 Library"   ON
-HDF5_BUILD_TOOLS        "Build HDF5 Tools"                ON
-HDF5_BUILD_HL_GIF_TOOLS "Build HIGH Level HDF5 GIF Tools" OFF
+HDF5_BUILD_CPP_LIB        "Build HDF5 C++ Library"          OFF
+HDF5_BUILD_EXAMPLES       "Build HDF5 Library Examples"     ON
+HDF5_BUILD_FORTRAN        "Build FORTRAN support"           OFF
+HDF5_BUILD_JAVA           "Build JAVA support"              OFF
+HDF5_BUILD_HL_LIB         "Build HIGH Level HDF5 Library"   ON
+HDF5_BUILD_TOOLS          "Build HDF5 Tools"                ON
+HDF5_BUILD_HL_GIF_TOOLS   "Build HIGH Level HDF5 GIF Tools" OFF
+HDF5_BUILD_PARALLEL_TOOLS "Build Parallel HDF5 Tools"       OFF
 
 ---------------- HDF5 Folder Build Options ---------------------
 Defaults relative to $<INSTALL_PREFIX>
@@ -809,8 +810,8 @@ else ()
   HDF5_INSTALL_DATA_DIR   "share"
 HDF5_INSTALL_DOC_DIR      "HDF5_INSTALL_DATA_DIR"
 
-HDF5_USE_GNU_DIRS         "TRUE to use GNU Coding Standard install directory variables,
-                           FALSE to use historical settings"                                     FALSE
+HDF5_USE_GNU_DIRS         "ON to use GNU Coding Standard install directory variables,
+                           OFF to use historical settings"                                       OFF
 Defaults as defined by the `GNU Coding Standards`
 HDF5_INSTALL_BIN_DIR      "bin"
 HDF5_INSTALL_LIB_DIR      "lib"
@@ -839,6 +840,7 @@ HDF5_ENABLE_EMBEDDED_LIBINFO   "embed library info into executables"
 HDF5_ENABLE_PREADWRITE         "Use pread/pwrite in sec2/log/core VFDs in place of read/write (when available)" ON
 HDF5_ENABLE_TRACE              "Enable API tracing capability"                                   OFF
 HDF5_ENABLE_USING_MEMCHECKER   "Indicate that a memory checker is used"                          OFF
+HDF5_ENABLE_MAP_API            "Build the map API"                                               OFF
 HDF5_GENERATE_HEADERS          "Rebuild Generated Files"                                         ON
 HDF5_BUILD_GENERATORS          "Build Test Generators"                                           OFF
 
@@ -904,7 +906,7 @@ if (BUILD_TESTING)
 ---------------- External Library Options ---------------------
 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"                                     ON
+HDF5_ENABLE_SZIP_SUPPORT    "Use SZip Filter"                                     OFF
 HDF5_ENABLE_Z_LIB_SUPPORT   "Enable Zlib Filters"                                 ON
 
 ZLIB_USE_EXTERNAL         "Use External Library Building for ZLIB"    OFF