From 5a41ec17e45b2a55f5dea57552c56da24cdb45bc Mon Sep 17 00:00:00 2001 From: Binh-Minh Date: Fri, 22 Mar 2024 02:33:43 -0400 Subject: [PATCH] Summarize the library version table Fixes GH-3773 --- src/H5Ppublic.h | 285 +++++++++++------------------------------------- 1 file changed, 65 insertions(+), 220 deletions(-) diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h index 2b9b2f7292e..afbf880a912 100644 --- a/src/H5Ppublic.h +++ b/src/H5Ppublic.h @@ -4854,280 +4854,125 @@ H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref); * * * \p low=#H5F_LIBVER_EARLIEST
- * \p high=#H5F_LIBVER_V18 + * \p high= * * \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. - * - * - * \p low=#H5F_LIBVER_EARLIEST
- * \p high=#H5F_LIBVER_V110 - * - * \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. - * - * - * \p low=#H5F_LIBVER_EARLIEST
- * \p high=#H5F_LIBVER_V112 - * - * \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. - * - * - * \p low=#H5F_LIBVER_EARLIEST
- * \p high=#H5F_LIBVER_V114 - * - * \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. - * - * - * \p low=#H5F_LIBVER_EARLIEST
- * \p high=#H5F_LIBVER_V116 - * - * \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. - * - * - * \p low=#H5F_LIBVER_V18
- * \p high=#H5F_LIBVER_V18 - * - * \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. - * - * - * \p low=#H5F_LIBVER_V18
- * \p high=#H5F_LIBVER_V110 - * - * \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. - * - * - * \p low=#H5F_LIBVER_V18
- * \p high=#H5F_LIBVER_V112 - * - * \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. + * available to versions of the library greater than the + * specified version in \p high will fail. * * * \p low=#H5F_LIBVER_V18
- * \p high=#H5F_LIBVER_V114 + * \p high= * * \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. - * - * - * \p low=#H5F_LIBVER_V18
- * \p high=#H5F_LIBVER_V116 - * - * \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. * * * \p low=#H5F_LIBVER_V110
- * \p high=#H5F_LIBVER_V110 - * - * \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. - * - * - * \p low=#H5F_LIBVER_V110
- * \p high=#H5F_LIBVER_V112 - * - * \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. - * - * - * \p low=#H5F_LIBVER_V110
- * \p high=#H5F_LIBVER_V114 + * \p high= * * \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. - * - * - * \p low=#H5F_LIBVER_V110
- * \p high=#H5F_LIBVER_V116 - * - * \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. * * * \p low=#H5F_LIBVER_V112
- * \p high=#H5F_LIBVER_V112 + * \p high= * * \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. * * - * \p low=#H5F_LIBVER_V112
- * \p high=#H5F_LIBVER_V114 + * \p low=#H5F_LIBVER_V114
+ * \p high= * * \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. * * - * \p low=#H5F_LIBVER_V112
- * \p high=#H5F_LIBVER_V116 - * - * \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. + * \p low=high + * + * \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. * * - * \p low=#H5F_LIBVER_V114
- * \p high=#H5F_LIBVER_V114 - * - * \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. + * \p low=#H5F_LIBVER_EARLIEST
+ * \p high=#H5F_LIBVER_LATEST + * + * \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. * * - * \p low=#H5F_LIBVER_V114
- * \p high=#H5F_LIBVER_V116 - * - * \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. + * \p low=
+ * \p high=#H5F_LIBVER_LATEST + * + * \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. * * - * \p low=#H5F_LIBVER_V116
- * \p high=#H5F_LIBVER_V116 + * \p low=#H5F_LIBVER_LATEST
+ * \p high=#H5F_LIBVER_LATEST * * \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.