summaryrefslogtreecommitdiffstats
path: root/release_docs
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2022-10-25 15:50:43 (GMT)
committerGitHub <noreply@github.com>2022-10-25 15:50:43 (GMT)
commitea902f9acefec5303cb3e3527d4472e97956a122 (patch)
tree80be2bb4a7e373a81d8bde511e361d3cd8bfcdca /release_docs
parentf98c93ab193bd7258f165de8c61a1809087975ee (diff)
downloadhdf5-ea902f9acefec5303cb3e3527d4472e97956a122.zip
hdf5-ea902f9acefec5303cb3e3527d4472e97956a122.tar.gz
hdf5-ea902f9acefec5303cb3e3527d4472e97956a122.tar.bz2
Implement option for using CMake GNUInstallDirs (#2175)
* Implement option for using CMake GNUInstallDirs * Add release notes
Diffstat (limited to 'release_docs')
-rw-r--r--release_docs/INSTALL_CMake.txt16
-rw-r--r--release_docs/RELEASE.txt12
2 files changed, 26 insertions, 2 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index 27f5c38..ad030fa 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -753,8 +753,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 +844,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 80cf38d..c5a3ebc 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)
+
- Update CMake minimum version to 3.18
Updated CMake minimum version from 3.12 to 3.18 and removed version checks
@@ -55,8 +65,6 @@ New Features
(ADB - 2022/08/29, HDFFV-11329)
- -
-
Library:
--------