Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the library version matrix for H5Pset_libver_bounds() #3702

Merged
merged 3 commits into from
Oct 20, 2023
Merged

Update the library version matrix for H5Pset_libver_bounds() #3702

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce6d495
Fixed #3524
bmribler Oct 17, 2023
9f7b922
Committing clang-format changes
github-actions[bot] Oct 17, 2023
fc6df55
Fixed typos
bmribler Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
308 changes: 288 additions & 20 deletions src/H5Ppublic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4830,9 +4830,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>
Expand All @@ -4859,11 +4858,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>
Expand All @@ -4887,11 +4928,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>
Expand All @@ -4904,20 +4988,204 @@ 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.
* 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.
* objects created with this setting.
* </td>
* </tr>
* </table>
Expand Down