Skip to content

Commit

Permalink
Merge pull request #42 from HDFGroup/phoenix
Browse files Browse the repository at this point in the history
links for hdf5 1.14.3 release and documentation
  • Loading branch information
loricooperhdf authored Nov 21, 2023
2 parents 23de6bc + 2c673f2 commit c354e75
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 8 deletions.
Binary file modified .DS_Store
Binary file not shown.
Binary file modified documentation/.DS_Store
Binary file not shown.
30 changes: 30 additions & 0 deletions documentation/hdf5-docs/Migrating+from+HDF5+1.12+to+HDF5+1.14.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## 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.

## 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.
13 changes: 7 additions & 6 deletions documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-docs/Migrating+from+HDF5+1.12+to+HDF5+1.14.html)

## HDF4
* Building HDF4 with Cmake

Expand Down
Binary file modified downloads/.DS_Store
Binary file not shown.
5 changes: 3 additions & 2 deletions downloads/hdf5/hdf5_1_14_3.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit c354e75

Please sign in to comment.