diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in index 3a160c1701f..496758d0c68 100644 --- a/docs/doxygen/Doxyfile.in +++ b/docs/doxygen/Doxyfile.in @@ -187,8 +187,12 @@ TAB_SIZE = 4 # with the commands \{ and \} for these it is advised to use the version @{ and # @} or use a double escape (\\{ and \\}) - -ALIASES = +# PREVIOUS_VER needs more complex determination, especially for major releases +# and for patch releases in the event that the latest release is a patch release +# in a different minor release series. For this release it is set to the known +# previous release. +ALIASES = "CURRENT_VER=@HDF5_PACKAGE_VERSION@" \ + "PREVIOUS_VER=2.2.0" @INCLUDE_PATH = @DOXYGEN_INCLUDE_ALIASES_PATH@ @INCLUDE = @DOXYGEN_INCLUDE_ALIASES@ diff --git a/docs/doxygen/dox/hdf5_2x.dox b/docs/doxygen/dox/hdf5_2x.dox index 1292e0a0ffb..8553b4dee57 100644 --- a/docs/doxygen/dox/hdf5_2x.dox +++ b/docs/doxygen/dox/hdf5_2x.dox @@ -27,7 +27,7 @@ Additional Release Information -CHANGELOG.md +CHANGELOG.md @@ -55,14 +55,7 @@ Additional Release Information -[Newsletter Announcement](https://www.hdfgroup.org/2026/03/10/release-of-hdf5-2-1-0-newsletter-209/) - - - - - - -ABI/API Compatibility Reports between 2.1.0 and 2.0.0 [tar file](https://github.com/HDFGroup/hdf5/releases/download/2.1.0/hdf5-2.1.0.html.abi.reports.tar.gz) or [individual html files](https://\RELURL/2.1.0/documentation/compat_reports/index.html) +ABI/API Compatibility Reports [tar file](https://github.com/HDFGroup/hdf5/releases/download/\PREVIOUS_VER/hdf5-\PREVIOUS_VER.html.abi.reports.tar.gz) or [individual html files](https://\RELURL/\PREVIOUS_VER/documentation/compat_reports/index.html) @@ -78,22 +71,22 @@ ABI/API Compatibility Reports between 2.1.0 and 2.0.0 [tar file](https://github. \subsection subsec_download_2x Downloads Source code and binaries are available at: -HDF5 2.1.0 on GitHub - -Please refer to [Build instructions](https://\SRCURLALL/hdf5_2.1.0/release_docs/INSTALL) for building with CMake. +HDF5 \PREVIOUS_VER on GitHub +Please refer to [Build instructions](https://\SRCURLALL/\PREVIOUS_VER/docs/INSTALL.md) for building with CMake. \subsection subsec_obtain_method_2x Methods to obtain (gz file) -\li firefox – Download file and then run: `gzip .tar.gz | tar xzf -` -\li chrome – Download file and then run: `gzip -cd .tar.gz | tar xvf -` -\li wget – -
- `wget https://github.com/HDFGroup/hdf5/releases/download/${PACKAGEVERSION}/.tar.gz`
- `gzip -cd .tar.gz | tar xvf -` -
-\li `` is hdf5-${PACKAGEVERSION}, where PACKAGEVERSION is 2.1.0 for this release +To download and extract the source tarfile, please follow one of the methods below, where ${PACKAGEVERSION} is \PREVIOUS_VER for this release. +1. Download the tarfile in a web browser, and extract it with gzip as: +@code gzip -cd hdf5-${PACKAGEVERSION}.tar.gz | tar xvf -@endcode + +2. Download the tarfile with wget on a terminal and extract with these commands: +@code + wget https://github.com/HDFGroup/hdf5/releases/download/${PACKAGEVERSION}/hdf5-${PACKAGEVERSION}.tar.gz + gzip -cd hdf5-${PACKAGEVERSION}.tar.gz | tar xvf - +@endcode \subsection subsec_dox_gen_doc_2x Doxygen Generated Reference Manual @@ -105,7 +98,7 @@ Since this portion of the HDF5 documentation is now part of the source code, it \section sec_rel_spec_2x_migrate Migrating from HDF5 1.14 to HDF5 2.x -This section highlights some changes that might affect migrating to HDF5 2.x, please refer to the \ref sec_rel_spec_2x_change or the CHANGELOG.md for detail. +This section highlights some changes that might affect migrating to HDF5 2.x, please refer to the \ref sec_rel_spec_2x_change or the HDF5 2.0.0 CHANGELOG.md for detail. \li Default file format is now 1.8 \li The file format has been updated to 4.0 @@ -113,15 +106,27 @@ This section highlights some changes that might affect migrating to HDF5 2.x, pl - `H5Dread_chunk()`
- `H5Tdecode()`
- `H5Iregister_type()`
-\li A new backend based on the [aws-c-s3 library](https://github.com/awslabs/aws-c-s3) replaced the ROS3 VFD's S3 backend based on libcurl. The ROS3 VFD now requires the `aws-c-s3` library in order to be built. See the CHANGELOG.md for a complete description on this feature. +\li A new backend based on the [aws-c-s3 library](https://github.com/awslabs/aws-c-s3) replaced the ROS3 VFD's S3 backend based on libcurl. The ROS3 VFD now requires the `aws-c-s3` library in order to be built. See the CHANGELOG.md for a complete description on this feature. \li Significance in tools - The tool h5dump has a new option `--lformat` and its `XML` option is deprecated. - - The high-level GIF tools, `h52gif` and `gif2h5` have been removed. We may move them to a separate repository in the future. See CHANGELOG.md for an explanation. + - The high-level GIF tools, `h52gif` and `gif2h5` have been removed. We may move them to a separate repository in the future. See CHANGELOG.md for an explanation. \section sec_rel_spec_2x_feat New Features in HDF5 Release 2.x This section includes the new features introduced in the HDF5 2.x series: +\subsubsection subsubsec_in220 In 2.2.0 + +\li Faster Access to Data Stored in S3 +
A major enhancement in HDF5 2.2.0 is the addition of an I/O block cache for the ROS3 Virtual File Driver (VFD). By reducing the number of requests sent to Amazon S3 for files that do not use paged allocation, applications can achieve more efficient cloud-based data access with fewer network transactions and improved overall performance. +
Additional optimizations delay initial file caching until the first read operation, reducing file-open overhead. + +\li Enhanced Security with Signed Plugin Support +
HDF5 2.2.0 introduces optional digital signature verification for dynamically loaded plugins. Organizations can now cryptographically verify plugins before loading them, helping protect scientific and production environments from unauthorized or modified plugin binaries. +
A new h5sign utility allows developers to sign plugin libraries using RSA signatures, while configurable keystores support trusted-key management and signature revocation. + +\subsubsection subsubsec_in200 In 2.0.0 + \li \ref_rfc20240129complex
Support for the C99 `float _Complex`, `double _Complex` and `long double _Complex` (with MSVC, `_Fcomplex`, `_Dcomplex` and `_Lcomplex`) types has been added for platforms/compilers that support them. These types have been implemented with a new datatype class, `H5T_COMPLEX`. Note that any datatypes of class H5T_COMPLEX will not be readable with previous versions of HDF5. If a file is accessed with a library version bounds "high" setting less than `H5F_LIBVER_V200`, an error will occur if the application tries to create an object with a complex number datatype. If compatibility with previous versions of HDF5 is desired, applications should instead consider adopting [one of the existing conventions](https://nc-complex.readthedocs.io/en/latest/#conventions-used-in-applications).
diff --git a/docs/doxygen/dox/sw_changes_2.x.dox b/docs/doxygen/dox/sw_changes_2.x.dox index 3105cecf64b..8329ffff1b7 100644 --- a/docs/doxygen/dox/sw_changes_2.x.dox +++ b/docs/doxygen/dox/sw_changes_2.x.dox @@ -15,10 +15,12 @@ be aware of between successive releases of HDF5, such as: \subsection subsec_rel_spec_2x_change_compat API Compatibility See \ref api-compat-macros for details of HDF5 versions when considering upgrading to the later HDF5 release to take advantage of the library features and enhancements. -\li Compatibility reports for Release 2.1.0 versus Release 2.0.0 +\li Compatibility reports for Release 2.2.0 versus Release 2.1.1 +\li Compatibility reports for Release 2.1.1 versus Release 2.0.0 \li Compatibility reports for Release 2.0.0 versus Release 1.14.6 \subsection subsec_rel_spec_2x_bw_releases Changes between releases +\li \ref subsubsec_rel_spec_2x_change_22versus21 \li \ref subsubsec_rel_spec_2x_change_21versus20 \li \ref subsubsec_rel_spec_2x_change_20versus14_6 @@ -26,9 +28,33 @@ The CHANGELOG.md file (a.k.a. RELEASE.txt prior to release 2.x) also lists chang The CHANGELOG.md files are listed in each release section and can be found at the top level of the HDF5 source code tree in the release_docs directory. +\subsubsection subsubsec_rel_spec_2x_change_22versus21 Release 2.2.0 versus Release 2.1.0 + +The new public APIs introduced in HDF5 2.2.0 are: + + + + + + + + + + + +
Function/ConstantDescription
+H5Pget_fapl_ros3_block_caching() + +Queries a File Access Property List for H5FD_ROS3 I/O block caching parameters +
+H5Pset_fapl_ros3_block_caching() + +Modifies the specified File Access Property List to set I/O block caching parameters for the H5FD_ROS3 driver +
+ \subsubsection subsubsec_rel_spec_2x_change_21versus20 Release 2.1.0 versus Release 2.0.0 -List of new public APIs/Macros +The new public Macros introduced in HDF5 2.1.0 are:
Function/ConstantDescription