Skip to content

Commit

Permalink
Merge pull request HDFGroup#134 from bmribler/format_release_specifics
Browse files Browse the repository at this point in the history
Fix paths and format
  • Loading branch information
bmribler authored Mar 16, 2024
2 parents 73bf99e + dc17459 commit 2153569
Show file tree
Hide file tree
Showing 12 changed files with 57 additions and 57 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ There were many existing functions that were modified in 1.12. Applications crea

For further information, see:

* [New Features in 1.12](/documentation/hdf5-docs/release_specifics/new_features_1_12.md)
* [Software Changes from release to release](/documentation/hdf5-docs/release_specifics/sw_changes_1.12.md)
* [API Compatibility Macros in HDF5](/documentation/hdf5-docs/release_specifics/api_comp_macros.md)
* [New Features in 1.12](new_features_1_12.md)
* [Software Changes from release to release](sw_changes_1.12.md)
* [API Compatibility Macros in HDF5](api_comp_macros.md)

### Compiling 1.10 and earlier applications with 1.12

Expand Down Expand Up @@ -56,7 +56,7 @@ Functions were modified in HDF5 version 1.12 to support a token type used in the
The updated versions of the functions have a number (for eg '2' or '3') at the end of the original function name.
The original versions of these functions were retained and renamed to have an earlier number (for eg '1') at the end of the original function name.
A macro was created with the name of the original function.
Please read [API Compatibility Macros in HDF5](/documentation/hdf5-docs/release_specifics/api_comp_macros.md) for more details on how the function names changed in version 1.12.
Please read [API Compatibility Macros in HDF5](api_comp_macros.md) for more details on how the function names changed in version 1.12.
~~~

### Token Type
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The HDF5 1.10.* binaries are not ABI compatible with the HDF5 1.8.* binaries due

### Can I migrate my application if I still use the HDF5 1.6 APIs?

Yes, use the -DH5_USE_16_API compiler flag. For more information see the [API compatibility Macros in HDF5](documentation/hdf5-docs/release_specifics/api_comp_macros.md) document.
Yes, use the -DH5_USE_16_API compiler flag. For more information see the [API compatibility Macros in HDF5](api_comp_macros.md) document.

### Will my old software read files created by an application rebuilt with HDF5 1.10?

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
HDF5 provides asynchronous APIs for the HDF5 VOL connectors that
support asynchronous HDF5 operations using the [HDF5 Event Set](/documentation/hdf5-docs/release_specifics/event_set.md) (H5ES)
support asynchronous HDF5 operations using the [HDF5 Event Set](event_set.md) (H5ES)
API. This allows I/O to proceed in the background while the application
is performing other tasks.

Expand Down Expand Up @@ -35,4 +35,4 @@ herr_t H5Dclose_async(hid_t dset_id, hid_t es_id);

An event set is an in-memory object that is created by an application and used to track many asynchronous operations with a single object. They function like a ``bag'' -- holding request tokens from one or more asynchronous operations and provide a simple interface for inspecting the status of the entire set of operations.

See the [H5ES](/documentation/hdf5-docs/release_specifics/event_set.md) APIs that were added to the HDF5 library to manage event sets.
See the [H5ES](event_set.md) APIs that were added to the HDF5 library to manage event sets.
8 changes: 4 additions & 4 deletions documentation/hdf5-docs/release_specifics/hdf5_1_10.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ redirect_from:
- display/HDF5/HDF5+1.10+Release
---

### [Migrating from HDF5 1.8 to HDF5 1.10](/documentation/hdf5-docs/release_specifics/Migrating_from_HDF5_1.8_to_HDF5_1.10.md)
### [Migrating from HDF5 1.8 to HDF5 1.10](Migrating_from_HDF5_1.8_to_HDF5_1.10.md)

### [New Features in HDF5 Release 1.10](/documentation/hdf5-docs/release_specifics/new_features_1_10.md)
### [New Features in HDF5 Release 1.10](new_features_1_10.md)

* [Additional New APIs](/documentation/hdf5-docs/release_specifics/additional_APIs.md)
* [Additional New APIs](additional_APIs.md)
* [Chunk Query Functionality (RFC)](https://docs.hdfgroup.org/hdf5/rfc/RFC-Chunking%20Functions-2018-06-20-v3.docx.pdf)
* [Minimum Object Headers (RFC)](https://docs.hdfgroup.org/hdf5/rfc/RFC_Min_Obj_Headers_181231.pdf)
* [Parallel Library Change (RFC)](https://docs.hdfgroup.org/hdf5/develop/_r_f_c.html)
* [Read Proc0 and Bcast (RFC)](https://docs.hdfgroup.org/hdf5/rfc/3.2.1_3.2.2_deliverable_181220_v4.pdf)
* [Setting Bounds for Object Creation in HDF5-1.10.0 - RFC](https://docs.hdfgroup.org/hdf5/rfc/RFC-bounds.pdf)

### [Software Changes from Release to Release for HDF5-1.10](/documentation/hdf5-docs/release_specifics/sw_changes_1.10.md)
### [Software Changes from Release to Release for HDF5-1.10](sw_changes_1.10.md)
8 changes: 4 additions & 4 deletions documentation/hdf5-docs/release_specifics/hdf5_1_12.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ redirect_from:
- display/HDF5/HDF5+1.12+Release
---

### [Migrating from HDF5 1.10 to HDF5 1.12](/documentation/hdf5-docs/release_specifics/Migrating_from_HDF5_1.10_to_HDF5_1.12.md)
### [Migrating from HDF5 1.10 to HDF5 1.12](Migrating_from_HDF5_1.10_to_HDF5_1.12.md)

### [New Features in HDF5 Release 1.12](/documentation/hdf5-docs/release_specifics/new_features_1_12.md)
### [New Features in HDF5 Release 1.12](new_features_1_12.md)

* [H5Sencode / H5Sdecode Format Change - RFC](https://docs.hdfgroup.org/hdf5/rfc/H5Sencode_format.docx.pdf)
* [Update to References](https://docs.hdfgroup.org/hdf5/rfc/RFC_Update_to_HDF5_References.pdf)
* [Update to Selections](https://docs.hdfgroup.org/hdf5/rfc/selection_io_RFC_210610.pdf)
* [Virtual Object Layer](https://docs.hdfgroup.org/hdf5/develop/_v_o_l__connector.html)
* [Hyperslab Performance Improvement](#Hyperslab-Performance-Improvements)
* [Hyperslab Performance Improvement](need link Hyperslab-Performance-Improvements)

### [Software Changes from Release to Release for HDF5 1.12](/documentation/hdf5-docs/release_specifics/sw_changes_1.12.md)
### [Software Changes from Release to Release for HDF5 1.12](sw_changes_1.12.md)
6 changes: 3 additions & 3 deletions documentation/hdf5-docs/release_specifics/hdf5_1_14.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ redirect_from:
- display/HDF5/HDF5+1.14+Release
---

### [Migrating from HDF5 1.12 to HDF5 1.14](/documentation/hdf5-docs/release_specifics/Migrating_from_HDF5_1.12_to_HDF5_1.14.md)
### [Migrating from HDF5 1.12 to HDF5 1.14](Migrating_from_HDF5_1.12_to_HDF5_1.14.md)

### [New Features in HDF5 Release 1.14](/documentation/hdf5-docs/release_specifics/new_features_1_14.md)
### [New Features in HDF5 Release 1.14](new_features_1_14.md)

* [H5Sencode / H5Sdecode Format Change - RFC](https://docs.hdfgroup.org/hdf5/rfc/H5Sencode_format.docx.pdf)
* [Update to References](https://docs.hdfgroup.org/hdf5/rfc/RFC_Update_to_HDF5_References.pdf)
* [Update to Selections](https://docs.hdfgroup.org/hdf5/rfc/selection_io_RFC_210610.pdf)
* [Virtual Object Layer](https://docs.hdfgroup.org/hdf5/develop/_v_o_l__connector.html)

### [Software Changes from Release to Release for HDF5 1.14](/documentation/hdf5-docs/release_specifics/sw_changes_1.14.md)
### [Software Changes from Release to Release for HDF5 1.14](sw_changes_1.14.md)
4 changes: 2 additions & 2 deletions documentation/hdf5-docs/release_specifics/hdf5_1_8.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ redirect_from:
- display/HDF5/HDF5+1.8+Release
---

### [New Features in HDF5 Release 1.8](/documentation/hdf5-docs/release_specifics/new_features_1_8.md)
### [New Features in HDF5 Release 1.8](new_features_1_8.md)

### [Software Changes from Release to Release for HDF5-1.8](/documentation/hdf5-docs/release_specifics/sw_changes_1.8.md)
### [Software Changes from Release to Release for HDF5-1.8](sw_changes_1.8.md)
14 changes: 7 additions & 7 deletions documentation/hdf5-docs/release_specifics/new_features_1_10.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ redirect_from:

HDF5 1.10 introduces several new features in the HDF5 library. These new features were added in the first three releases of HDF5-1.10. For a brief description of each new feature see:

* [New Features Introduced in HDF5 1.10.8](#New-Features-Introduced-in-HDF5-1.10.8)
* [New Features Introduced in HDF5 1.10.7](#New-Features-Introduced-in-HDF5-1.10.7)
* [New Features introduced in HDF5 1.10.6](#New-Features-Introduced-in-HDF5-1.10.6)
* [New Features introduced in HDF5 1.10.5](#New-Features-Introduced-in-HDF5-1.10.5)
* [New Features Introduced in HDF5 1.10.2](#New-Features-Introduced-in-HDF5-1.10.2)
* [New Features Introduced in HDF5 1.10.1](#New-Features-Introduced-in-HDF5-1.10.1)
* [New Features Introduced in HDF5 1.10.0](#New-Features-Introduced-in-HDF5-1.10.0)
* [New Features Introduced in HDF5 1.10.8](#new-features-introduced-in-hdf5-1.10.8)
* [New Features Introduced in HDF5 1.10.7](#new-features-introduced-in-hdf5-1.10.7)
* [New Features introduced in HDF5 1.10.6](#new-features-introduced-in-hdf5-1.10.6)
* [New Features introduced in HDF5 1.10.5](#new-features-introduced-in-hdf5-1.10.5)
* [New Features Introduced in HDF5 1.10.2](#new-features-introduced-in-hdf5-1.10.2)
* [New Features Introduced in HDF5 1.10.1](#new-features-introduced-in-hdf5-1.10.1)
* [New Features Introduced in HDF5 1.10.0](#new-features-introduced-in-hdf5-1.10.0)

~~~
This release includes changes in the HDF5 storage format. For detailed information on the changes, see: Changes to the File Format Specification
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ HDF5 1.12 introduces several new features in the HDF5 library:
* [Update to References](https://docs.hdfgroup.org/hdf5/rfc/RFC_Update_to_HDF5_References.pdf)
* [Update to Selections](https://docs.hdfgroup.org/hdf5/rfc/selection_io_RFC_210610.pdf)
* [Virtual Object Layer](https://docs.hdfgroup.org/hdf5/develop/_v_o_l__connector.html)
* [Hyperslab Performance Improvement](#Hyperslab-Performance-Improvements)
* [Hyperslab Performance Improvement](need link #Hyperslab-Performance-Improvements)

### Virtual Object Layer (VOL) (RFC)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ redirect_from:

HDF5 Release 1.14.0 is the final released version of all the features that were released in 1.13.0-1.13.3. Thus, the new features in the HDF4 1.14 release include:

* [Asynchronous I/O operations](/documentation/hdf5-docs/release_specifics/asyn_ops_wHDF5_VOL_connectors.md)
* [Asynchronous I/O operations](asyn_ops_wHDF5_VOL_connectors.md)
HDF5 provides asynchronous APIs for the HDF5 VOL connectors that
support asynchronous HDF5 operations using the HDF5 Event Set (H5ES)
API. This allows I/O to proceed in the background while the application
Expand Down
54 changes: 27 additions & 27 deletions documentation/hdf5-docs/release_specifics/release_specific_info.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
title: Release Specific Information
redirect_from:
- display/HDF5/Release+Specific+Information
---

### [HDF5 1.14](/documentation/hdf5-docs/release_specifics/hdf5_1_14.md)
* [New Features](/documentation/hdf5-docs/release_specifics/new_features_1_14.md)
* [Software Changes from Release to Release](/documentation/hdf5-docs/release_specifics/sw_changes_1.14.md)
* [Migrating to HDF5 1.14 from previous releases](/documentation/hdf5-docs/release_specifics/Migrating_from_HDF5_1.12_to_HDF5_1.14.md)

### [HDF5 1.12](/documentation/hdf5-docs/release_specifics/hdf5_1_12.md)
* [New Features](documentation/hdf5-docs/release_specifics/new_features_1_12.md)
* [Software Changes from Release to Release](/documentation/hdf5-docs/release_specifics/sw_changes_1.12.md)
* [Migrating from HDF5 1.10 to HDF5 1.12](/documentation/hdf5-docs/release_specifics/Migrating_from_HDF5_1.10_to_HDF5_1.12.md)

### [HDF5 1.10](/documentation/hdf5-docs/release_specifics/hdf5_1_10.md)
* [New Features](documentation/hdf5-docs/release_specifics/new_features_1_10.md)
* [Why should I care about the HDF5-1.10.2 release? (blog)]()
* [Software Changes from Release to Release](/documentation/hdf5-docs/release_specifics/sw_changes_1.10.md)
* [Migrating from HDF5 1.8 to HDF5 1.10](/documentation/hdf5-docs/release_specifics/Migrating_from_HDF5_1.8_to_HDF5_1.10.md)

### [HDF5 1.8](/documentation/hdf5-docs/release_specifics/hdf5_1_8.md)
* New Features
* [Software Changes from Release to Release](/documentation/hdf5-docs/release_specifics/sw_changes_1.8.md)

### [API compatibility Macros in HDF5](documentation/hdf5-docs/release_specifics/api_comp_macros.md)
---
title: Release Specific Information
redirect_from:
- display/HDF5/Release+Specific+Information
---

### [HDF5 1.14](hdf5_1_14.md)
* [New Features](new_features_1_14.md)
* [Software Changes from Release to Release](sw_changes_1.14.md)
* [Migrating to HDF5 1.14 from previous releases](Migrating_from_HDF5_1.12_to_HDF5_1.14.md)

### [HDF5 1.12](hdf5_1_12.md)
* [New Features](documentation/hdf5-docs/release_specifics/new_features_1_12.md)
* [Software Changes from Release to Release](sw_changes_1.12.md)
* [Migrating from HDF5 1.10 to HDF5 1.12](Migrating_from_HDF5_1.10_to_HDF5_1.12.md)

### [HDF5 1.10](hdf5_1_10.md)
* [New Features](documentation/hdf5-docs/release_specifics/new_features_1_10.md)
* [Why should I care about the HDF5-1.10.2 release? (blog)]()
* [Software Changes from Release to Release](sw_changes_1.10.md)
* [Migrating from HDF5 1.8 to HDF5 1.10](Migrating_from_HDF5_1.8_to_HDF5_1.10.md)

### [HDF5 1.8](hdf5_1_8.md)
* New Features
* [Software Changes from Release to Release](sw_changes_1.8.md)

### [API compatibility Macros in HDF5](documentation/hdf5-docs/release_specifics/api_comp_macros.md)
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ redirect_from:
- /display/HDF5/Software+Changes+from+Release+to+Release+for+HDF5+1.12
---

For a description of the major new features that were introduced, please see [New Features in HDF5 Release 1.12](/documentation/hdf5-docs/release_specifics/sw_changes_1.12.md).
For a description of the major new features that were introduced, please see [New Features in HDF5 Release 1.12](sw_changes_1.12.md).

This page provides information on the changes that a maintenance developer needs to be aware of between successive releases of HDF5, such as:

Expand Down

0 comments on commit 2153569

Please sign in to comment.