Skip to content

Commit d366d72

Browse files
Update API tests README.md with current information (#5348)
1 parent 352501a commit d366d72

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

test/API/README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ public API and serve as regression tests for HDF5 [VOL Connectors](https://hdfgr
55

66
## Build Process and options
77

8-
These HDF5 API tests are disabled by default, but can be enabled by passing the
9-
`-DHDF5_TEST_API=ON` option to CMake. The following build options are available
8+
These HDF5 API tests are enabled by default, but can be disabled by passing the
9+
`-DHDF5_TEST_API=OFF` option to CMake. The following build options are available
1010
to influence how the API tests get built:
1111

1212
### CMake
@@ -18,7 +18,7 @@ For example,
1818

1919
`HDF5_TEST_API` (Default: `ON`) - Determines whether the API tests will be built.
2020

21-
`HDF5_TEST_API_INSTALL` (Default: `ON`) - Determines whether the API tests should be installed
21+
`HDF5_TEST_API_INSTALL` (Default: `OFF`) - Determines whether the API tests should be installed
2222
on the system.
2323

2424
`HDF5_TEST_API_ENABLE_ASYNC` (Default: `OFF`) - Determines whether tests for HDF5's asynchronous
@@ -28,7 +28,8 @@ this functionality, so these tests are directed towards VOL connectors that do.
2828
`HDF5_TEST_ENABLE_DRIVER` (Default: `OFF`) - Determines whether the API test driver program should
2929
be built. This driver program is useful when a VOL connector relies upon a server executable
3030
(as well as possible additional executables) in order to function. The driver program can be
31-
supplied with a server executable and
31+
supplied with a server executable and server/client arguments to use when running the API
32+
tests.
3233

3334
`HDF5_TEST_API_SERVER` (Default: empty string) - If `HDF5_TEST_ENABLE_DRIVER` is set to `ON`, this
3435
option should be edited to point to the server executable that the driver program should attempt
@@ -44,16 +45,19 @@ These API tests currently only support usage with the native HDF5 VOL connector
4445
connectors that can be loaded dynamically as a plugin. For information on how to build a VOL
4546
connector in this manner, refer to section 2.3 of the [HDF5 VOL Connector Author Guide](https://hdfgroup.github.io/hdf5/develop/_v_o_l__connector.html).
4647

47-
TODO: section on building VOL connectors alongside HDF5 for use with tests
48+
If an HDF5 VOL connector has been built alongside the library, these API tests can be used
49+
for testing that VOL connector at the same time that HDF5 is test. For more information on
50+
how to build a VOL connector alongside the HDF5 library, refer to
51+
[Building and testing HDF5 VOL connectors with CMake FetchContent](https://hdfgroup.github.io/hdf5/develop/df/d6b/_c_make_vols.html).
4852

4953
These API tests can also be used to test an HDF5 VOL connector that is external to the library.
5054
For convenience, the `HDF5_TEST_API_INSTALL` option can be used to install these tests on the
51-
system where other HDF5 executables (such as `h5dump`) are installed.
52-
53-
To run these tests with your VOL connector, set the following two environment variables:
55+
system where other HDF5 executables (such as `h5dump`) are installed. To run these tests manually
56+
with your VOL connector, set the following two environment variables:
5457

5558
`HDF5_VOL_CONNECTOR` - This environment variable should be set to the name chosen for the VOL connector
56-
to be used. For example, HDF5's DAOS VOL connector uses the name "[daos](https://github.com/HDFGroup/vol-daos/blob/v1.2.0/src/daos_vol.h#L30)" and would therefore set:
59+
to be used. For example, HDF5's DAOS VOL connector uses the name "[daos](https://github.com/HDFGroup/vol-daos/blob/v1.2.0/src/daos_vol.h#L30)"
60+
and would therefore set:
5761

5862
HDF5_VOL_CONNECTOR=daos
5963

0 commit comments

Comments
 (0)