Summarize the library version table (#4212)

Fixes GH-3773
This commit is contained in:
bmribler 2024-03-22 12:54:46 -04:00 committed by GitHub
parent 06c42ff038
commit 174c22df22
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -4854,131 +4854,111 @@ H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref);
* </tr> * </tr>
* <tr> * <tr>
* <td>\p low=#H5F_LIBVER_EARLIEST<br /> * <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> * <td>
* \li The library will create objects with the earliest * \li The library will create objects with the earliest
* possible format versions. * possible format versions.
* \li The library will allow objects to be created with the * \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 * \li API calls that create objects or features that are
* available to versions of the library greater than 1.8.x * available to versions of the library greater than the
* release will fail.</td> * specified version in \p high 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>
* <tr> * <tr>
* <td>\p low=#H5F_LIBVER_V18<br /> * <td>\p low=#H5F_LIBVER_V18<br />
* \p high=#H5F_LIBVER_V18</td> * \p high=<any version higher than \p low but not #H5F_LIBVER_LATEST></td>
* <td> * <td>
* \li The library will create objects with the latest format * \li The library will create objects with the latest format
* versions available to library release 1.8.x. * versions available to library release 1.8.x.
* \li The library will allow objects to be created with the latest * \li The library will allow objects to be created with the latest
* format versions available to library release 1.8.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 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=<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 specified
* in the \p high value.
* \li API calls that create objects or features that are available
* 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=<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 specified
* in the \p high value.
* \li API calls that create objects or features that are available
* 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_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.14.x.
* \li The library will allow objects to be created with the 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 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=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 * \li The objects written with this setting may be
* accessible to a smaller range of library versions than * accessible to a smaller range of library versions than
* would be the case if low is set to #H5F_LIBVER_EARLIEST. * would be the case if low is set to #H5F_LIBVER_EARLIEST.
* \li API calls that create objects or features that are available * \li API calls that create objects or features that are available
* to versions of the library greater than 1.8.x release will * to versions of the library greater than the specified
* 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. * release will fail.
* \li Earlier versions of the library may not be able to access * \li Earlier versions of the library may not be able to access
* objects created with this setting.</td> * objects created with this setting.</td>
* </tr> * </tr>
* <tr> * <tr>
* <td>\p low=#H5F_LIBVER_V18<br /> * <td>\p low=#H5F_LIBVER_EARLIEST<br />
* \p high=#H5F_LIBVER_V112</td> * \p high=#H5F_LIBVER_LATEST</td>
* <td> * <td>
* \li The library will create objects with the latest format * \li The library will create objects with the earliest possible
* versions available to library release 1.8.x. * format versions.
* \li The library will allow objects to be created with the latest * \li The library will allow objects to be created with the latest
* format versions available to library release 1.12.x. * format versions available to the latest release. See
* \li API calls that create objects or features that are * note #H5F_LIBVER_LATEST below the table.
* available to versions of the library greater than 1.12.x * \li This is the library default setting and provides the greatest
* release will fail. * format compatibility.</td>
* \li Earlier versions of the library may not be able to access
* objects created with this setting.</td>
* </tr> * </tr>
* <tr> * <tr>
* <td>\p low=#H5F_LIBVER_V18<br /> * <td>\p low=<any version lower than \p high><br/>
* \p high=#H5F_LIBVER_V114</td> * \p high=#H5F_LIBVER_LATEST</td>
* <td> * <td>
* \li The library will create objects with the latest format * \li The library will create objects with the latest format
* versions available to library release 1.8.x. * versions available to library release \p low.
* \li The library will allow objects to be created with the latest * \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 the latest release. See
* \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. * note *H5F_LIBVER_LATEST* below the table.
* \li This setting allows users to take advantage of the latest * \li This setting allows users to take advantage of the latest
* features and performance enhancements in the library. * features and performance enhancements in the library.
@ -4986,148 +4966,13 @@ H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref);
* objects created with this setting.</td> * objects created with this setting.</td>
* </tr> * </tr>
* <tr> * <tr>
* <td>\p low=#H5F_LIBVER_V110<br /> * <td>\p low=#H5F_LIBVER_LATEST<br />
* \p high=#H5F_LIBVER_V110</td> * \p high=#H5F_LIBVER_LATEST</td>
* <td> * <td>
* \li The library will create objects with the latest format * \li The library will create objects with the latest format
* versions available to library release 1.10.x. * versions available to the latest release.
* \li The library will allow objects to be created with the latest * \li The library will allow objects to be created with the latest
* format versions available to library release 1.10.x. * format versions available to the latest release. See
* \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>
* <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 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.
* \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>
* <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>
* </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 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_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>
* </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>
* </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>
* </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. See
* note *H5F_LIBVER_LATEST* below the table. * note *H5F_LIBVER_LATEST* below the table.
* \li This setting allows users to take advantage of the latest * \li This setting allows users to take advantage of the latest
* features and performance enhancements in the library. * features and performance enhancements in the library.