summaryrefslogtreecommitdiffstats
path: root/release_docs
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2022-11-04 15:37:17 (GMT)
committerGitHub <noreply@github.com>2022-11-04 15:37:17 (GMT)
commit52854566ecad891ee60458777932539d3edab6e0 (patch)
treeacf73fd6f48220b972e0c53ecccb18bee072dff5 /release_docs
parent7a1885451213244da0b244338435830fc4dd6ea1 (diff)
downloadhdf5-52854566ecad891ee60458777932539d3edab6e0.zip
hdf5-52854566ecad891ee60458777932539d3edab6e0.tar.gz
hdf5-52854566ecad891ee60458777932539d3edab6e0.tar.bz2
1.12 Merge HDFGroup#2175 Implement option for using CMake GNUInstallDirs (#2221)
Diffstat (limited to 'release_docs')
-rw-r--r--release_docs/INSTALL_CMake.txt19
-rw-r--r--release_docs/RELEASE.txt10
2 files changed, 28 insertions, 1 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index 95576e1..44d3203 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -32,7 +32,8 @@ CMake version
1. We suggest you obtain the latest CMake from the Kitware web site.
The HDF5 1.12."X" product requires a minimum CMake version 3.12,
where "X" is the current HDF5 release version. If you are using
- VS2019, the minimum version is 3.15.
+ VS2019, the minimum version is 3.15. For VS2022, the minimum
+ version is 3.21.
Note:
To change the install prefix from the platform defaults initialize
@@ -753,8 +754,20 @@ if (MSVC)
HDF5_INSTALL_DATA_DIR "."
else ()
HDF5_INSTALL_DATA_DIR "share"
+HDF5_INSTALL_DOC_DIR "HDF5_INSTALL_DATA_DIR"
+
+Defaults as defined by the `GNU Coding Standards`
+HDF5_INSTALL_BIN_DIR "bin"
+HDF5_INSTALL_LIB_DIR "lib"
+HDF5_INSTALL_INCLUDE_DIR "include"
+HDF5_INSTALL_MODULE_DIR "HDF5_INSTALL_INCLUDE_DIR/mod"
+HDF5_INSTALL_CMAKE_DIR "HDF5_INSTALL_LIB_DIR/cmake"
+HDF5_INSTALL_DATA_DIR "share"
+HDF5_INSTALL_DOC_DIR "HDF5_INSTALL_DATA_DIR/doc/hdf5"
---------------- HDF5 Advanced Options ---------------------
+HDF5_USE_GNU_DIRS "TRUE to use GNU Coding Standard install directory variables,
+ FALSE to use historical settings" FALSE
ONLY_SHARED_LIBS "Only Build Shared Libraries" OFF
ALLOW_UNSUPPORTED "Allow unsupported combinations of configure options" OFF
HDF5_EXTERNAL_LIB_PREFIX "Use prefix for custom library naming." ""
@@ -832,6 +845,10 @@ NOTE:
flag is not available on windows and some modern linux systems will
ignore the flag.
+NOTE:
+ The HDF5_USE_GNU_DIRS option is usually recommended for linux platforms, but may
+ be useful on other platforms. See the CMake documentation for more details.
+
---------------- Unsupported Library Options ---------------------
The threadsafe, C++ and Java interfaces are not compatible
with the HDF5_ENABLE_PARALLEL option.
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index ce18ed9..96e452a 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -47,6 +47,16 @@ New Features
Configuration:
-------------
+ - Add new CMake configuration variable HDF5_USE_GNU_DIRS
+
+ HDF5_USE_GNU_DIRS (default OFF) selects the use of GNU Coding Standard install
+ directory variables by including the CMake module, GNUInstallDirs(see CMake
+ documentation for details). The HDF_DIR_PATHS macro in the HDFMacros.cmake file
+ sets various PATH variables for use during the build, test and install processes.
+ By default, the historical settings for these variables will be used.
+
+ (ADB - 2022/10/21, GH-2175, GH-1716)
+
- Correct the usage of CMAKE_Fortran_MODULE_DIRECTORY and where to
install Fortran mod files.