From c23b51280bbbdd7dfe1a3f4ca0f34cd8492003a3 Mon Sep 17 00:00:00 2001 From: Binh-Minh Date: Wed, 17 Apr 2024 03:47:18 -0400 Subject: [PATCH] Update documentation - added replacement for https://docs.hdfgroup.org/archive/support/HDF5/doc/TechNotes/Version.html - added replacement for the backward/forward compatibility discussion to workaround the dead link issue; however, it's severely outdated, hence, the contents are not included, awaiting a revision. --- doxygen/dox/TechnicalNotes.dox | 14 + doxygen/examples/BackwardForwardCompat.html | 210 ++++++++++++ doxygen/examples/FileImageOps.html | 2 + doxygen/examples/H5.format.html | 4 +- .../LibraryReleaseVersionNumbers.html | 320 ++++++++++++++++++ doxygen/img/images_to_copy.dox | 1 + doxygen/img/trunk_branches.jpg | Bin 0 -> 51564 bytes 7 files changed, 549 insertions(+), 2 deletions(-) create mode 100644 doxygen/examples/BackwardForwardCompat.html create mode 100644 doxygen/examples/LibraryReleaseVersionNumbers.html create mode 100644 doxygen/img/trunk_branches.jpg diff --git a/doxygen/dox/TechnicalNotes.dox b/doxygen/dox/TechnicalNotes.dox index 6f98f688a6e..b3bc8b9bde9 100644 --- a/doxygen/dox/TechnicalNotes.dox +++ b/doxygen/dox/TechnicalNotes.dox @@ -10,6 +10,7 @@ \li \ref MT \li \ref SWMR \li \ref VDS +\li \ref RELVERSION \li \ref VFL */ @@ -26,6 +27,12 @@ */ +/** \page RELVERSION HDF5 Library Release Version Numbers + +\htmlinclude LibraryReleaseVersionNumbers.html + +*/ + /** \page VFL HDF5 Virtual File Layer \htmlinclude VFL.html @@ -67,3 +74,10 @@ \htmlinclude intro_VDS.html */ + +/** \page BKFWDCOMPAT HDF5 Backward and Forward Compatibility Issues + +\htmlinclude BackwardForwardCompat.html + +*/ + diff --git a/doxygen/examples/BackwardForwardCompat.html b/doxygen/examples/BackwardForwardCompat.html new file mode 100644 index 00000000000..24f44baaa31 --- /dev/null +++ b/doxygen/examples/BackwardForwardCompat.html @@ -0,0 +1,210 @@ + + +HDF5 Backward and Forward Compatibility Issues + + + + +

This document discusses backward and forward compatibility issues across releases of the HDF5 Library and versions of the HDF5 file format in the form of FAQs. Backward compatibility refers to one of the following questions: Can a newer (later) library read a file and/or objects within a file that were created or written by an older (earlier) library? + +

(to be revised...)

+ + +- - Last modified: 17 August 2015 + + + diff --git a/doxygen/examples/FileImageOps.html b/doxygen/examples/FileImageOps.html index 87dfd7b1afb..2409979ff7b 100644 --- a/doxygen/examples/FileImageOps.html +++ b/doxygen/examples/FileImageOps.html @@ -1,4 +1,5 @@ + HDF5 File Image Operations