From d1620e3a7585813558570b57969ca3b57ea9ef2c Mon Sep 17 00:00:00 2001 From: Dave Allured Date: Tue, 1 Feb 2022 09:58:36 -0700 Subject: [PATCH] hdf5set_format_compatibility.c: Function docs. Comment change only. Add one paragraph. Explain the reason for the third argument to H5Pset_libver_bounds. Simplifies experimental code using advanced features. --- libhdf5/hdf5set_format_compatibility.c | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/libhdf5/hdf5set_format_compatibility.c b/libhdf5/hdf5set_format_compatibility.c index cec9575dd7..7a5328f784 100644 --- a/libhdf5/hdf5set_format_compatibility.c +++ b/libhdf5/hdf5set_format_compatibility.c @@ -44,13 +44,21 @@ * created the file. Mixed-object files of this nature are common * and do not suffer any serious problems. * - * See netcdf-c github issues #250 and #951 for more details about - * the rationale and evolution of netCDF-4 format compatibility. + * Also note that the THIRD function argument to H5Pset_libver_bounds + * below, is set to "high = H5F_LIBVER_LATEST" in all cases. This + * setting does not affect object versions used by default in + * netCDF-4. Its purpose is for new or experimental code, to enable + * the possible application of new HDF5 features such as SWMR, + * without additional complication of this format control function. + * + * See netcdf-c github issues #250, #951, and PR #2176 for more + * details about the rationale and evolution of netCDF-4 format + * compatibility. * * See HDF5 documentation for H5Pset_libver_bounds and related RFC's, * for more details about HDF5 file object versioning. * - * @author Dave Allured, NOAA/PSL/CIRES @date 2022 January 11 + * @author Dave Allured, NOAA/PSL/CIRES @date 2022 January 21 */ #include "config.h"