summaryrefslogtreecommitdiffstats
path: root/release_docs
diff options
context:
space:
mode:
authorjhendersonHDF <jhenderson@hdfgroup.org>2023-05-03 21:11:38 (GMT)
committerGitHub <noreply@github.com>2023-05-03 21:11:38 (GMT)
commit25a8ba9fde67d1287e1966f3155aece2fdb46f9a (patch)
tree2019a0cb3e9c69c568813b1b7155e18ed3c32722 /release_docs
parent1054efdaf8cc76a4024bcbefb3aafb8cb8ce6c1b (diff)
downloadhdf5-25a8ba9fde67d1287e1966f3155aece2fdb46f9a.zip
hdf5-25a8ba9fde67d1287e1966f3155aece2fdb46f9a.tar.gz
hdf5-25a8ba9fde67d1287e1966f3155aece2fdb46f9a.tar.bz2
Add RELEASE.txt entry for API tests (#2889)
Diffstat (limited to 'release_docs')
-rw-r--r--release_docs/RELEASE.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index b3aa5b6..d0ac38f 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -47,6 +47,48 @@ New Features
Configuration:
-------------
+ - Added new CMake options for building and running HDF5 API tests
+ (Experimental)
+
+ HDF5 API tests are an experimental feature, primarily targeted
+ toward HDF5 VOL connector authors, that is currently being developed.
+ These tests exercise the HDF5 API and are being integrated back
+ into the HDF5 library from the HDF5 VOL tests repository
+ (https://github.com/HDFGroup/vol-tests). To support this feature,
+ the following new options have been added to CMake:
+
+ * HDF5_TEST_API: ON/OFF (Default: OFF)
+
+ Controls whether the HDF5 API tests will be built. These tests
+ will only be run during testing of HDF5 if the HDF5_TEST_SERIAL
+ (for serial tests) and HDF5_TEST_PARALLEL (for parallel tests)
+ options are enabled.
+
+ * HDF5_TEST_API_INSTALL: ON/OFF (Default: OFF)
+
+ Controls whether the HDF5 API test executables will be installed
+ on the system alongside the HDF5 library. This option is currently
+ not functional.
+
+ * HDF5_TEST_API_ENABLE_ASYNC: ON/OFF (Default: OFF)
+
+ Controls whether the HDF5 Async API tests will be built. These
+ tests will only be run if the VOL connector used supports Async
+ operations.
+
+ * HDF5_TEST_API_ENABLE_DRIVER: ON/OFF (Default: OFF)
+
+ Controls whether to build the HDF5 API test driver program. This
+ test driver program is useful for VOL connectors that use a
+ client/server model where the server needs to be up and running
+ before the VOL connector can function. This option is currently
+ not functional.
+
+ * HDF5_TEST_API_SERVER: String (Default: "")
+
+ Used to specify a path to the server executable that the test
+ driver program should execute.
+
- Added support for CMake presets file.
CMake supports two main files, CMakePresets.json and CMakeUserPresets.json,