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.

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

Summarize the library version table #4212

Merged
merged 1 commit into from
Mar 22, 2024
Merged
Changes from all commits
Commits
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
285 changes: 65 additions & 220 deletions src/H5Ppublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -4854,280 +4854,125 @@ H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref);
* </tr>
* <tr>
* <td>\p low=#H5F_LIBVER_EARLIEST<br />
* \p high=#H5F_LIBVER_V18</td>
* \p high=<any other version but not #H5F_LIBVER_LATEST></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.8.x.
* latest format versions available to library release
* specified in the \p high value.
* \li API calls that create objects or features that are
* available to versions of the library greater than 1.8.x
* release will fail.</td>
* </tr>
* <tr>
* <td>\p low=#H5F_LIBVER_EARLIEST<br />
* \p high=#H5F_LIBVER_V110</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.10.x.
* \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.
* \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. See
* note *H5F_LIBVER_LATEST* below the table.
* \li This is the library default setting and provides the greatest
* format compatibility.</td>
* </tr>
* <tr>
* <td>\p low=#H5F_LIBVER_V18<br />
* \p high=#H5F_LIBVER_V18</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.8.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.8.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_V110</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.10.x.
* \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>
* available to versions of the library greater than the
* specified version in \p high will fail.</td>
* </tr>
* <tr>
* <td>\p low=#H5F_LIBVER_V18<br />
* \p high=#H5F_LIBVER_V114</td>
* \p high=<any version higher than \p low but not #H5F_LIBVER_LATEST></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.
* format versions available to library release specified
* in the \p high value.
* \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. See
* note *H5F_LIBVER_LATEST* below the table.
* \li This setting allows users to take advantage of the latest
* features and performance enhancements in the library.
* available to versions of the library greater than the
* specified version in \p high 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_V110<br />
* \p high=#H5F_LIBVER_V110</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.10.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.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_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 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_V110<br />
* \p high=#H5F_LIBVER_V114</td>
* \p high=<any version higher than \p low but not #H5F_LIBVER_LATEST></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.
* format versions available to library release specified
* in the \p high value.
* \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_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. See
* note *H5F_LIBVER_LATEST* below the table.
* \li This setting allows users to take advantage of the latest
* features and performance enhancements in the library.
* to versions of the library greater than version specified in
* \p high 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_V112<br />
* \p high=#H5F_LIBVER_V112</td>
* \p high=<any version higher than \p low but not #H5F_LIBVER_LATEST></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.
* format versions available to library release specified
* in the \p high value.
* \li API calls that create objects or features that are available
* to versions of the library greater than 1.12.x release will
* fail.
* to versions of the library greater than version specified in
* \p high 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_V112<br />
* \p high=#H5F_LIBVER_V114</td>
* <td>\p low=#H5F_LIBVER_V114<br />
* \p high=<any version higher than \p low but not #H5F_LIBVER_LATEST></td>
* <td>
* \li The library will create objects with the latest format
* versions available to library release 1.12.x.
* 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.
* format versions available to library release specified
* in the \p high value.
* \li API calls that create objects or features that are available
* to versions of the library greater than 1.14.x release will
* fail.
* to versions of the library greater than version specified in
* \p high 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_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. See
* note *H5F_LIBVER_LATEST* below the table.
* \li This setting allows users to take advantage of the latest
* features and performance enhancements in the library.
* \li Earlier versions of the library may not be able to access
* objects created with this setting.</td>
* <td>\p low=high </td>
* <td>
* \li The library will create objects with the latest format
* versions available to library release specified.
* \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 the specified
* 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_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>\p low=#H5F_LIBVER_EARLIEST<br />
* \p high=#H5F_LIBVER_LATEST</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 the latest release. See
* note #H5F_LIBVER_LATEST below the table.
* \li This is the library default setting and provides the greatest
* format compatibility.</td>
* </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. See
* note *H5F_LIBVER_LATEST* below the table.
* \li This setting allows users to take advantage of the latest
* features and performance enhancements in the library.
* \li Earlier versions of the library may not be able to access
* objects created with this setting.</td>
* <td>\p low=<any version lower than \p high><br/>
* \p high=#H5F_LIBVER_LATEST</td>
* <td>
* \li The library will create objects with the latest format
* versions available to library release \p low.
* \li The library will allow objects to be created with the latest
* format versions available to the latest release. See
* note *H5F_LIBVER_LATEST* below the table.
* \li This setting allows users to take advantage of the latest
* features and performance enhancements in the library.
* \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>\p low=#H5F_LIBVER_LATEST<br />
* \p high=#H5F_LIBVER_LATEST</td>
* <td>
* \li The library will create objects with the latest format
* versions available to library release 1.16.x.
* versions available to the latest release.
* \li The library will allow objects to be created with the latest
* format versions available to library release 1.16.x. See
* format versions available to the latest release. See
* note *H5F_LIBVER_LATEST* below the table.
* \li This setting allows users to take advantage of the latest
* features and performance enhancements in the library.
Expand Down
Loading