Skip to content

Commit

Permalink
Summarize the library version table (HDFGroup#4212)
Browse files Browse the repository at this point in the history 
Fixes HDFGroupGH-3773
  • Loading branch information
@bmribler @qkoziol
bmribler authored and qkoziol committed Mar 23, 2024
1 parent 6b31164 commit f6adf23
Showing 1 changed file with 65 additions and 220 deletions.
285 changes: 65 additions & 220 deletions src/H5Ppublic.h
View file
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

0 comments on commit f6adf23

Please sign in to comment.