summaryrefslogtreecommitdiffstats
path: root/release_docs
diff options
context:
space:
mode:
authorGlenn Song <43005495+glennsong09@users.noreply.github.com>2024-02-14 13:37:18 (GMT)
committerLarry Knox <lrknox@hdfgroup.org>2024-02-14 22:11:04 (GMT)
commit8837ed7bc22f8ef98df805b5f0a8bfcd32208099 (patch)
treebf6e64789dc2c5ed3bde5ce489aa3063acc16bc8 /release_docs
parent1ac9bd3afb9a3f19d1193d2eb97ebd06f462ffe3 (diff)
downloadhdf5-8837ed7bc22f8ef98df805b5f0a8bfcd32208099.zip
hdf5-8837ed7bc22f8ef98df805b5f0a8bfcd32208099.tar.gz
hdf5-8837ed7bc22f8ef98df805b5f0a8bfcd32208099.tar.bz2
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
Diffstat (limited to 'release_docs')
-rw-r--r--release_docs/INSTALL_Auto.txt (renamed from release_docs/INSTALL)8
-rw-r--r--release_docs/INSTALL_CMake.txt22
2 files changed, 12 insertions, 18 deletions
diff --git a/release_docs/INSTALL b/release_docs/INSTALL_Auto.txt
index dd70d0c..969fbac 100644
--- a/release_docs/INSTALL
+++ b/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
index f6ba3a1..f794d3c 100644
--- 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