From 0e4048320ebf31d4260defef1002189230baa35d Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Tue, 21 Nov 2023 11:34:54 -0600 Subject: [PATCH 1/7] Create Migrating+from+HDF5+1.12+to+HDF5+1.14.md --- .../Migrating+from+HDF5+1.12+to+HDF5+1.14.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md diff --git a/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md b/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md new file mode 100644 index 00000000..421b3cad --- /dev/null +++ b/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md @@ -0,0 +1,35 @@ +## API Changes +There are new API calls that require API Compatibility Macros in HDF5 1.14.0. There are, however, two API calls which have had their signature change. + +### `H5Iregister_type()` / `H5I_free_t` +The signature of `H5Iregister_type()` did not change, but the `H5I_free_t` callback it accepts did have its signature change to add an asynchronous request parameter. There is no API compatibility macro to paper over this change. The request parameter can be ignored in the callback if you are not concerned with asynchronous operations and future IDs. A description of how the request parameter should be used will be found in the (soon to be released) HDF5 Asynchronous Programming Guide. + + *Old:* + + `typedef herr_t (*H5I_free_t)(void *obj);` + + *New:* + + `typedef herr_t (*H5I_free_t)(void *obj, void **request);` + +### `H5VLquery_optional()` +The way optional operations are handled in the virtual object layer (VOL) changed significantly in HDF5 1.14.0. To better support this, the `H5VLquery_optional()` API call now takes an output flags parameter instead of a Boolean. Since the entire 1.12 VOL API has been deprecated, no API compatibility macro exists for this API call. + + *Old:* + + `herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, hbool_t *supported);` + + *New:* + + `herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, uint64_t *flags);` + +## Virtual File Layer (VFL) Changes +The virtual file layer has changed in HDF5 1.14.0. Existing virtual file drivers (VFDs) will have to be updated to work with this version of the library.. + +For details, see the (soon to be released) 1.12 to 1.14. VFL Migration Guide. + +## Virtual Object Layer (VOL) Changes +The virtual object layer has changed significantly in HDF5 1.14.0 and the 1.12 VOL API is now considered deprecated and unsupported. Existing virtual object layer connectors shoul be updated to work with this version of the library. + +For details, see the (soon to be released) 1.12 to 1.14. VOL Migration Guide. + From a0ce8c1e5b95da2c8612f6056d09776c1a56991e Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Tue, 21 Nov 2023 11:36:27 -0600 Subject: [PATCH 2/7] Update Migrating+from+HDF5+1.12+to+HDF5+1.14.md --- .../hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md b/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md index 421b3cad..0e9cd7cf 100644 --- a/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md +++ b/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md @@ -4,22 +4,22 @@ There are new API calls that require API Compatibility Macros in HDF5 1.14.0. Th ### `H5Iregister_type()` / `H5I_free_t` The signature of `H5Iregister_type()` did not change, but the `H5I_free_t` callback it accepts did have its signature change to add an asynchronous request parameter. There is no API compatibility macro to paper over this change. The request parameter can be ignored in the callback if you are not concerned with asynchronous operations and future IDs. A description of how the request parameter should be used will be found in the (soon to be released) HDF5 Asynchronous Programming Guide. - *Old:* +   i**Old:** - `typedef herr_t (*H5I_free_t)(void *obj);` +   i`typedef herr_t (*H5I_free_t)(void *obj);` - *New:* +   i**New:** - `typedef herr_t (*H5I_free_t)(void *obj, void **request);` +   i`typedef herr_t (*H5I_free_t)(void *obj, void **request);` ### `H5VLquery_optional()` The way optional operations are handled in the virtual object layer (VOL) changed significantly in HDF5 1.14.0. To better support this, the `H5VLquery_optional()` API call now takes an output flags parameter instead of a Boolean. Since the entire 1.12 VOL API has been deprecated, no API compatibility macro exists for this API call. - *Old:* + **Old:** `herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, hbool_t *supported);` - *New:* + **New:** `herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, uint64_t *flags);` From 0bd0d90e9395695ab5de203d83de7214f138cf50 Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Tue, 21 Nov 2023 11:37:08 -0600 Subject: [PATCH 3/7] Update Migrating+from+HDF5+1.12+to+HDF5+1.14.md --- .../Migrating+from+HDF5+1.12+to+HDF5+1.14.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md b/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md index 0e9cd7cf..eb4aacc6 100644 --- a/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md +++ b/documentation/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.md @@ -4,24 +4,24 @@ There are new API calls that require API Compatibility Macros in HDF5 1.14.0. Th ### `H5Iregister_type()` / `H5I_free_t` The signature of `H5Iregister_type()` did not change, but the `H5I_free_t` callback it accepts did have its signature change to add an asynchronous request parameter. There is no API compatibility macro to paper over this change. The request parameter can be ignored in the callback if you are not concerned with asynchronous operations and future IDs. A description of how the request parameter should be used will be found in the (soon to be released) HDF5 Asynchronous Programming Guide. -   i**Old:** +  **Old:** -   i`typedef herr_t (*H5I_free_t)(void *obj);` +  `typedef herr_t (*H5I_free_t)(void *obj);` -   i**New:** +  **New:** -   i`typedef herr_t (*H5I_free_t)(void *obj, void **request);` +  `typedef herr_t (*H5I_free_t)(void *obj, void **request);` ### `H5VLquery_optional()` The way optional operations are handled in the virtual object layer (VOL) changed significantly in HDF5 1.14.0. To better support this, the `H5VLquery_optional()` API call now takes an output flags parameter instead of a Boolean. Since the entire 1.12 VOL API has been deprecated, no API compatibility macro exists for this API call. - **Old:** +  **Old:** - `herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, hbool_t *supported);` +  `herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, hbool_t *supported);` - **New:** +  **New:** - `herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, uint64_t *flags);` +  `herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, uint64_t *flags);` ## Virtual File Layer (VFL) Changes The virtual file layer has changed in HDF5 1.14.0. Existing virtual file drivers (VFDs) will have to be updated to work with this version of the library.. From a3f4226afc45df00f34c439f71281a9c66db552d Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Tue, 21 Nov 2023 11:53:00 -0600 Subject: [PATCH 4/7] Update index.md --- documentation/index.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/documentation/index.md b/documentation/index.md index 67fb8c29..d0208b72 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -3,12 +3,13 @@ Look for more content here soon. Here are some of our most popular help topics. ## HDF5 -* [Develop](/hdf5/develop/) -* [1.14.x](/hdf5/v1_14/index.html) -* [1.12.x](https://docs.hdfgroup.org/hdf5/v1_12/index.html) -* [1.10.x](https://docs.hdfgroup.org/hdf5/v1_10/index.html) -* [1.8.x](https://docs.hdfgroup.org/hdf5/v1_8/index.html) - +* [Documentation - Develop](/hdf5/develop/) +* [Documentation - 1.14.x](/hdf5/v1_14/index.html) +* [Documentation - 1.12.x](https://docs.hdfgroup.org/hdf5/v1_12/index.html) +* [Documentation - 1.10.x](https://docs.hdfgroup.org/hdf5/v1_10/index.html) +* [Documentation - 1.8.x](https://docs.hdfgroup.org/hdf5/v1_8/index.html) +* [Migrating from HD5 1.12 to HDF5 1.14](/hdf5/Migrating+from+HDF5+1.12+to+HDF5+1.14.html) + ## HDF4 * Building HDF4 with Cmake From c6dcc5e2a6d1d505f54f173b3640bc716403235e Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Tue, 21 Nov 2023 11:57:43 -0600 Subject: [PATCH 5/7] File management --- .DS_Store | Bin 8196 -> 8196 bytes documentation/.DS_Store | Bin 6148 -> 6148 bytes .../Migrating+from+HDF5+1.12+to+HDF5+1.14.md | 0 documentation/index.md | 2 +- downloads/.DS_Store | Bin 6148 -> 6148 bytes 5 files changed, 1 insertion(+), 1 deletion(-) rename documentation/{hdf5 => hdf5-docs}/Migrating+from+HDF5+1.12+to+HDF5+1.14.md (100%) diff --git a/.DS_Store b/.DS_Store index 7737fff3ca466854b78720fc79a432199af8b25b..16fb43a388f259c365cdd30c98a869e49f3913b2 100644 GIT binary patch delta 313 zcmZp1XmQw}DiB{V+lGOGfrUYjA)O(Up(Hoo#U&{xKM5$tadl-$#N@W4j;Qh}aC!F1 z8Os8jQRNFV41<&Na|?ia7#R8$7$z?i5ZOFKK$eL~>C0qkVL2gW3wYJ~6DPM#mK0VH z$jwKXTjB9`*JN>F14f6*4@JZ$#|v{aZkwDfT<9uRU2S1zuA^X3tD{hDX=I?IU}9-h zTg%BIs;qAv6rY`wo0s1KwwZyE5kfQYLTMP)Iayi6naStX!p;l;EwoYQ delta 303 zcmZp1XmQw}DiEK4^dSQS0}F#5LpnnyLrHGFi%U{YeiBfOBSTfNH?aArBdUA~UipFy z!{Frn+ybB;28Qkh43ifMh-{uAAj`xgWj|S3SWW=hf`lNArIW>lm4Jc>Q=x(eOa=^- z6-C4*#|v{a?wFh{T&ONlU2S1xqN8AJXjH4CP;F^sprc@7X;fRw$sww&Zygk$os*lF z-!++0M4qu5sMndv)&*=tjR+6NgWH^7&wvC(knKa3n0!HmkEsD{@8)kJ{LGu#CBCt2 J{w>1J3;>@9Qd|H4 diff --git a/documentation/.DS_Store b/documentation/.DS_Store index a101b57caa4ce04f450172a7c63bc75dbd8e8feb..fe4a61bb5d3bb56beb9bf8c69a9fb8a8ba2cbe1f 100644 GIT binary patch delta 188 zcmZoMXfc@JFUrEez`)4BAi%(&%aFp5&ydVeoRdB=ad|yRf|DTwD451ziY#duoSdIq z0F(s+4pSh3MOALTi%U{YeiBGYC}VNN>vI-<&_;FT}PFbq!4 z&n*BM3IvmznG6(^4ggs&8%&XHa9YpV8`wPgGE Date: Tue, 21 Nov 2023 12:35:40 -0600 Subject: [PATCH 6/7] Update hdf5_1_14_3.md --- downloads/hdf5/hdf5_1_14_3.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/downloads/hdf5/hdf5_1_14_3.md b/downloads/hdf5/hdf5_1_14_3.md index 455f452d..6ffaa0d7 100644 --- a/downloads/hdf5/hdf5_1_14_3.md +++ b/downloads/hdf5/hdf5_1_14_3.md @@ -10,8 +10,9 @@ || New Features in HDF5 Release 1.14 | || [Newsletter Announcement](https://www.hdfgroup.org/2023/10/release-of-hdf5-1-14-3-library-and-tools-newsletter-199/) | || [Doxygen generated Reference Manual](https://docs.hdfgroup.org/hdf5/v1_14/index.html) | -|| [API Compatibility Report between 1.12.2 and 1.12.3](https://github.com/HDFGroup/hdf5doc/blob/master/html/ADGuide/Compatibility_Report/hdf5-1.12.2-vs-hdf5-1.12.3-interface_compatibility_report.html) | -|| [Java Interface Compatibility Report between 1.12.2 and 1.12.3](https://github.com/HDFGroup/hdf5doc/blob/master/html/ADGuide/Compatibility_Report/hdf5-1.12.2-vs-hdf5-1.12.3-java-interface_compatibility_report.html) | +|| [API Compatibility Report between 1.14.2 and 1.14.3](https://raw.githubusercontent.com/HDFGroup/hdf5doc/master/html/ADGuide/Compatibility_Report/hdf5-1.14.2-vs-hdf5-1.14.3-interface_compatibility_report.html) | +|| [Java Interface Compatibility Report between 1.14.2 and 1.14.3](https://raw.githubusercontent.com/HDFGroup/hdf5doc/master/html/ADGuide/Compatibility_Report/hdf5-1.14.2-vs-hdf5-1.14.3-java-interface_compatibility_report.html) | + ## Files From 97c2503543cf224da7afe514cde6f53e5a72563c Mon Sep 17 00:00:00 2001 From: Lori Cooper Date: Tue, 21 Nov 2023 12:39:16 -0600 Subject: [PATCH 7/7] Update Migrating+from+HDF5+1.12+to+HDF5+1.14.md --- .../hdf5-docs/Migrating+from+HDF5+1.12+to+HDF5+1.14.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/documentation/hdf5-docs/Migrating+from+HDF5+1.12+to+HDF5+1.14.md b/documentation/hdf5-docs/Migrating+from+HDF5+1.12+to+HDF5+1.14.md index eb4aacc6..8ed9079f 100644 --- a/documentation/hdf5-docs/Migrating+from+HDF5+1.12+to+HDF5+1.14.md +++ b/documentation/hdf5-docs/Migrating+from+HDF5+1.12+to+HDF5+1.14.md @@ -24,12 +24,7 @@ The way optional operations are handled in the virtual object layer (VOL) change  `herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, uint64_t *flags);` ## Virtual File Layer (VFL) Changes -The virtual file layer has changed in HDF5 1.14.0. Existing virtual file drivers (VFDs) will have to be updated to work with this version of the library.. - -For details, see the (soon to be released) 1.12 to 1.14. VFL Migration Guide. +The virtual file layer has changed in HDF5 1.14.0. Existing virtual file drivers (VFDs) will have to be updated to work with this version of the library. ## Virtual Object Layer (VOL) Changes The virtual object layer has changed significantly in HDF5 1.14.0 and the 1.12 VOL API is now considered deprecated and unsupported. Existing virtual object layer connectors shoul be updated to work with this version of the library. - -For details, see the (soon to be released) 1.12 to 1.14. VOL Migration Guide. -