summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorbmribler <39579120+bmribler@users.noreply.github.com>2023-10-20 19:17:46 (GMT)
committerGitHub <noreply@github.com>2023-10-20 19:17:46 (GMT)
commit709367cb1a0d727d0e3fe07471c07cb184dd0b44 (patch)
tree09b3a597bd191852caeb8eddf1b56157963f5c14 /src
parent2d551c9b57a176dd23654e42e32d42f8e5aeb21f (diff)
downloadhdf5-709367cb1a0d727d0e3fe07471c07cb184dd0b44.zip
hdf5-709367cb1a0d727d0e3fe07471c07cb184dd0b44.tar.gz
hdf5-709367cb1a0d727d0e3fe07471c07cb184dd0b44.tar.bz2
Update the library version matrix for H5Pset_libver_bounds() (#3702)
* Fixed #3524 Added 1.12, 1.14, and 1.16 to the table for libver bounds in the H5Pset_libver_bounds docs.
Diffstat (limited to 'src')
-rw-r--r--src/H5Ppublic.h308
1 files changed, 288 insertions, 20 deletions
diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h
index d822925..d79c7d7 100644
--- a/src/H5Ppublic.h
+++ b/src/H5Ppublic.h
@@ -4837,9 +4837,8 @@ H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref);
* enumerated value in #H5F_libver_t, indicating that this is
* currently the latest format available.
*
- * The library supports the following five pairs of
- * (\p low, \p high) combinations as derived from the values
- * in #H5F_libver_t:
+ * The library supports the following pairs of (\p low, \p high)
+ * combinations as derived from the values in #H5F_libver_t:
*
* <table>
* <tr>
@@ -4866,11 +4865,53 @@ H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref);
* \li The library will create objects with the earliest possible
* format versions.
* \li The library will allow objects to be created with the latest
- * format versions available to library release 1.10.x.
- * Since 1.10.x is also #H5F_LIBVER_LATEST, there is no upper
- * limit on the format versions to use. For example, if a newer
- * format version is required to support a feature e.g. virtual
- * dataset, this setting will allow the object to be created.
+ * format versions available to library release 1.10.x. Note
+ * that as 1.10.11 is the last release of the 1.10 series.
+ * \li API calls that create objects or features that are
+ * available to versions of the library greater than 1.10.x
+ * release will fail.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_EARLIEST<br />
+ * \p high=#H5F_LIBVER_V112</td>
+ * <td>
+ * \li The library will create objects with the earliest possible
+ * format versions.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.12.x. Note
+ * that as 1.12.3 is the last release of the 1.12 series.
+ * \li API calls that create objects or features that are
+ * available to versions of the library greater than 1.12.x
+ * release will fail.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_EARLIEST<br />
+ * \p high=#H5F_LIBVER_V114</td>
+ * <td>
+ * \li The library will create objects with the earliest possible
+ * format versions.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.14.x.
+ * \li API calls that create objects or features that are
+ * available to versions of the library greater than 1.14.x
+ * release will fail.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_EARLIEST<br />
+ * \p high=#H5F_LIBVER_V116</td>
+ * <td>
+ * \li The library will create objects with the earliest possible
+ * format versions.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.16.x.
+ * Since 1.16.x is also #H5F_LIBVER_LATEST, there is no upper
+ * limit on the format versions to use. That is, if a
+ * newer format version is required to support a feature
+ * in 1.16.x series, this setting will allow the object to be
+ * created.
* \li This is the library default setting and provides the greatest
* format compatibility.
* </td>
@@ -4894,11 +4935,54 @@ H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref);
* \li The library will create objects with the latest format
* versions available to library release 1.8.x.
* \li The library will allow objects to be created with the latest
- * format versions available to library release 1.10.x.
- * Since 1.10.x is also #H5F_LIBVER_LATEST, there is no upper
- * limit on the format versions to use. For example, if a
- * newer format version is required to support a feature e.g.
- * virtual dataset, this setting will allow the object to be
+ * format versions available to library release 1.10.x. Note
+ * that 1.10.11 is the last release of the 1.10 series.
+ * \li API calls that create objects or features that are
+ * available to versions of the library greater than 1.10.x
+ * release will fail.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.</td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V18<br />
+ * \p high=#H5F_LIBVER_V112</td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.8.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.12.x.
+ * \li API calls that create objects or features that are
+ * available to versions of the library greater than 1.12.x
+ * release will fail.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.</td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V18<br />
+ * \p high=#H5F_LIBVER_V114</td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.8.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.14.x.
+ * \li API calls that create objects or features that are
+ * available to versions of the library greater than 1.14.x
+ * release will fail.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.</td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V18<br />
+ * \p high=#H5F_LIBVER_V116</td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.8.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.16.x.
+ * Since 1.16.x is also #H5F_LIBVER_LATEST, there is no upper
+ * limit on the format versions to use. That is, if a
+ * newer format version is required to support a feature
+ * in 1.16.x series, this setting will allow the object to be
* created.
* \li Earlier versions of the library may not be able to access
* objects created with this setting.</td>
@@ -4911,11 +4995,196 @@ H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref);
* \li The library will create objects with the latest format
* versions available to library release 1.10.x.
* \li The library will allow objects to be created with the latest
- * format versions available to library release 1.10.x.
- * Since 1.10.x is also #H5F_LIBVER_LATEST, there is no upper
- * limit on the format versions to use. For example, if a
- * newer format version is required to support a feature e.g.
- * virtual dataset, this setting will allow the object to be
+ * format versions available to library release 1.10.x. Note
+ * that 1.10.11 is the last release of the 1.10 series.
+ * \li The objects written with this setting may be
+ * accessible to a smaller range of library versions than
+ * would be the case if low is set to #H5F_LIBVER_EARLIEST.
+ * \li API calls that create objects or features that are available
+ * to versions of the library greater than 1.10.x release will
+ * fail.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.</td>
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V110<br />
+ * \p high=#H5F_LIBVER_V112
+ * </td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.10.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.12.x.
+ * \li The objects written with this setting may be
+ * accessible to a smaller range of library versions than
+ * would be the case if low is set to #H5F_LIBVER_EARLIEST.
+ * \li API calls that create objects or features that are available
+ * to versions of the library greater than 1.12.x release will
+ * fail.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.</td>
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V110<br />
+ * \p high=#H5F_LIBVER_V114
+ * </td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.10.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.14.x.
+ * \li The objects written with this setting may be
+ * accessible to a smaller range of library versions than
+ * would be the case if low is set to #H5F_LIBVER_EARLIEST.
+ * \li API calls that create objects or features that are available
+ * to versions of the library greater than 1.14.x release will
+ * fail.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.</td>
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V110<br />
+ * \p high=#H5F_LIBVER_V116
+ * </td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.10.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.16.x.
+ * Since 1.16.x is also #H5F_LIBVER_LATEST, there is no upper
+ * limit on the format versions to use. That is, if a
+ * newer format version is required to support a feature
+ * in 1.16.x series, this setting will allow the object to be
+ * created.
+ * \li This setting allows users to take advantage of the latest
+ * features and performance enhancements in the library.
+ * However, objects written with this setting may be
+ * accessible to a smaller range of library versions than
+ * would be the case if low is set to #H5F_LIBVER_EARLIEST.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.
+ * </td>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V112<br />
+ * \p high=#H5F_LIBVER_V112
+ * </td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.12.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.12.x.
+ * \li The objects written with this setting may be
+ * accessible to a smaller range of library versions than
+ * would be the case if low is set to #H5F_LIBVER_EARLIEST.
+ * \li API calls that create objects or features that are available
+ * to versions of the library greater than 1.12.x release will
+ * fail.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.</td>
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V112<br />
+ * \p high=#H5F_LIBVER_V114
+ * </td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.12.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.14.x.
+ * \li The objects written with this setting may be
+ * accessible to a smaller range of library versions than
+ * would be the case if low is set to #H5F_LIBVER_EARLIEST.
+ * \li API calls that create objects or features that are available
+ * to versions of the library greater than 1.14.x release will
+ * fail.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.</td>
+ * </td>
+ * </tr>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V112<br />
+ * \p high=#H5F_LIBVER_V116
+ * </td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.12.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.16.x.
+ * Since 1.16.x is also #H5F_LIBVER_LATEST, there is no upper
+ * limit on the format versions to use. That is, if a
+ * newer format version is required to support a feature
+ * in 1.16.x series, this setting will allow the object to be
+ * created.
+ * \li This setting allows users to take advantage of the latest
+ * features and performance enhancements in the library.
+ * However, objects written with this setting may be
+ * accessible to a smaller range of library versions than
+ * would be the case if low is set to #H5F_LIBVER_EARLIEST.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V114<br />
+ * \p high=#H5F_LIBVER_V114
+ * </td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.14.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.14.x.
+ * \li The objects written with this setting may be
+ * accessible to a smaller range of library versions than
+ * would be the case if low is set to #H5F_LIBVER_EARLIEST.
+ * \li API calls that create objects or features that are available
+ * to versions of the library greater than 1.14.x release will
+ * fail.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.</td>
+ * </td>
+ * </tr>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V114<br />
+ * \p high=#H5F_LIBVER_V116
+ * </td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.14.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.16.x.
+ * Since 1.16.x is also #H5F_LIBVER_LATEST, there is no upper
+ * limit on the format versions to use. That is, if a
+ * newer format version is required to support a feature
+ * in 1.16.x series, this setting will allow the object to be
+ * created.
+ * \li This setting allows users to take advantage of the latest
+ * features and performance enhancements in the library.
+ * However, objects written with this setting may be
+ * accessible to a smaller range of library versions than
+ * would be the case if low is set to #H5F_LIBVER_EARLIEST.
+ * \li Earlier versions of the library may not be able to access
+ * objects created with this setting.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td>\p low=#H5F_LIBVER_V116<br />
+ * \p high=#H5F_LIBVER_V116
+ * </td>
+ * <td>
+ * \li The library will create objects with the latest format
+ * versions available to library release 1.16.x.
+ * \li The library will allow objects to be created with the latest
+ * format versions available to library release 1.16.x.
+ * Since 1.16.x is also #H5F_LIBVER_LATEST, there is no upper
+ * limit on the format versions to use. That is, if a
+ * newer format version is required to support a feature
+ * in 1.16.x series, this setting will allow the object to be
* created.
* \li This setting allows users to take advantage of the latest
* features and performance enhancements in the library.
@@ -4923,8 +5192,7 @@ H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref);
* accessible to a smaller range of library versions than
* would be the case if low is set to #H5F_LIBVER_EARLIEST.
* \li Earlier versions of the library may not be able to access
- * objects created with this
- * setting.
+ * objects created with this setting.
* </td>
* </tr>
* </table>