summaryrefslogtreecommitdiffstats
path: root/src/H5FDsubfiling/H5FDsubfiling.h
diff options
context:
space:
mode:
authorjhendersonHDF <jhenderson@hdfgroup.org>2022-09-30 02:06:17 (GMT)
committerGitHub <noreply@github.com>2022-09-30 02:06:17 (GMT)
commit79bdc6183ee96cc36bd04569d4cce48202a8ae68 (patch)
tree86f1719b0b908ff9d174501bb339da384d9df5a4 /src/H5FDsubfiling/H5FDsubfiling.h
parent1bec0ce2d785b5c0d7f4514fb50f44b524fe4f67 (diff)
downloadhdf5-79bdc6183ee96cc36bd04569d4cce48202a8ae68.zip
hdf5-79bdc6183ee96cc36bd04569d4cce48202a8ae68.tar.gz
hdf5-79bdc6183ee96cc36bd04569d4cce48202a8ae68.tar.bz2
Subfiling testing fix and documentation (#2132)
* Fix a sporadic failure in Subfiling VFD tests * Subfiling VFD - add note to H5Pget_fapl_subfiling documentation Adds note about how H5Pget_fapl_subfiling only returns the original settings on a FAPL and those settings could have been modified by the Subfiling VFD's environment variables
Diffstat (limited to 'src/H5FDsubfiling/H5FDsubfiling.h')
-rw-r--r--src/H5FDsubfiling/H5FDsubfiling.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/H5FDsubfiling/H5FDsubfiling.h b/src/H5FDsubfiling/H5FDsubfiling.h
index 93d0c3e..23dae62 100644
--- a/src/H5FDsubfiling/H5FDsubfiling.h
+++ b/src/H5FDsubfiling/H5FDsubfiling.h
@@ -359,6 +359,16 @@ H5_DLL herr_t H5Pset_fapl_subfiling(hid_t fapl_id, const H5FD_subfiling_config_t
* the default values and then calling H5Pset_fapl_subfiling() with the configured
* H5FD_subfiling_config_t structure.
*
+ * \note H5Pget_fapl_subfiling() returns the #H5FD_SUBFILING driver properties as they
+ * were initially set for the File Access Property List using H5Pset_fapl_subfiling().
+ * Alternatively, the driver properties can be modified at runtime according to values
+ * set for the #H5FD_SUBFILING_STRIPE_SIZE, #H5FD_SUBFILING_IOC_PER_NODE and
+ * #H5FD_SUBFILING_IOC_SELECTION_CRITERIA environment variables. However, driver
+ * properties set through environment variables will not be reflected in what is
+ * returned by H5Pget_fapl_subfiling(), so an application may need to check those
+ * environment variables to get accurate values for the #H5FD_SUBFILING driver
+ * properties.
+ *
* \since 1.13.2
*
*/