[svn-r7137]

Description:
    Add H5_WANT_H5_V1_4_COMPAT notes.
    Add or expand "Changed Syntax" and "Deleted Functions" sections.
    Edited to refer to Release 1.6.0 (instead of R 1.5 Developoment Branch).
    Bring in sections from R 1.4 branch covering changes
        from R 1.2.2 through 1.4.5.

Platforms tested:
    IE 5
This commit is contained in:
Frank Baker 2003-07-02 15:05:15 -05:00
parent 91a04dd5c0
commit 1e07dfa83d

View File

@ -29,28 +29,23 @@
<h1>HDF5 Software Changes from Release to Release</h1>
</center>
<!-- Document API CHANGES ONLY in this file. -->
This document is intended to assist application developers who must keep
an application synchronized with the HDF5 library or related software.
<h2>Development Release 1.5 <br>(current development toward Production Release 1.6)</h2>
<h2>Release 1.6.0 (current release) versus Release 1.4.5</h2>
<dir>
This section lists the API-level changes that have been made during the
Release 1.5 development phase. (The development release number, 1.5,
will be used to describe this version until this the current development
cycle is completed, at which point it will be promoted to a production
release. The first production release of this code will be as Release 1.6.)
This section lists the API-level changes that have been made in the
transition from the HDF5 Release 1.4.<i>x</i> series to Release 1.6.0.
<p>
Note that changes at the subrelease level in the Release 1.4 production
branch, i.e., Releases 1.4.1, 1.4.2, ..., are summarized in the
Release 1.4.x versions of this document; they are not reported here.
<h3>New Functions and Tools</h3>
<dl>
<dt>The following functions are new for Release 1.5 and are included in the
<dt>The following functions are new for Release 1.6.0 and are included in the
<a href="../RM_H5Front.html"><cite>HDF5 Reference Manual</cite></a>.
<dd>
@ -348,81 +343,394 @@ Release 1.4.x versions of this document; they are not reported here.
<h3>Deleted Functions</h3>
The following functions have been removed from the HDF5 library
and from the <cite>HDF5 Reference Manual</cite>.
The following functions are deprecated in HDF5 Release 1.6.0.
A backward compatibility mode is provided in this release,
enabling these functions and other Release 1.4.x compatibility
features, but is available only when the HDF5 library is
configured with the flag <code>H5_WANT_H5_V1_4_COMPAT</code>.
The backward compatibility mode is not enabled in the
binaries distributed by NCSA.
<dir>
<table border=0>
<tr valign="top" align="left"><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
H5function1
H5function2
<code>H5Pset_hyper_cache</code>
<code>H5Pget_hyper_cache</code>
</pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
H5function3
H5function4
<code>H5Rget_object_type</code>
</pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
H5function5
H5function6
&nbsp;
</pre>
</td></tr>
</table>
</dir>
<p>
The above functions will eventually be removed from the HDF5
distribution and from the <cite>HDF5 Reference Manual</cite>.
<h3>Functions with Changed Syntax</h3>
The following functions have changed slightly.
The following functions have changed as noted.
<dir>
<dl>
<dt>C functions:
<dt><code>H5FDflush and VFL "flush" callbacks</code>
<dd>An extra parameter 'closing' has been added to these functions,
<dd>An extra parameter <code>closing</code> has been added to
these functions,
to allow the library to indicate that the file will be closed
following the call to "flush". Actions in the "flush" call
that are duplicated in the VFL "close" call may be omitted by
the VFL driver.
<dt><code>H5Sget_select_bounds</code>
<dd>The 'start' and 'end' parameters have changed from
<code>'hsize_t *'</code>
to <code>'hssize_t *'</code> to better match the rest of the dataspace API.
<dt>* <code>H5Gget_objtype_by_idx</code>
<dd>The function return type has changed from
<code><em>int</em></code> to
the enumerated type <code><em>H5G_obj_t</em></code>.
<dt>* <code>H5Pset(get)_buffer</code>
<dd>The <code>size</code> parameter for <code>H5Pset_buffer</code>
has changed from type <code><em>hsize_t</em></code> to
<code><em>size_t</em></code>.
<dd>The <code>H5Pget_buffer</code> return type has similarly
changed from <code><em>hsize_t</em></code> to
<code><em>size_t</em></code>.
<dt>* <code>H5Pset(get)_cache</code>
<dd>The <code>rdcc_nelmts</code> parameter has changed from type
<code><em>int</em></code> to
<code><em>size_t</em></code>.
<dt>* <code>H5Pset_fapl_log</code>
<dd>The <code>verbosity</code> parameter has been removed.
<dd>Two new parameters have been added:
<code>flags</code> of type <code><em>unsigned</em></code> and
<code>buf_size</code> of type <code><em>size_t</em></code>.
<dt>* <code>H5Pset(get)_fapl_mpiposix</code>
<dd>A <code>use_gpfs</code> parameter of type
<code><em>hbool_t</em></code> has been added.
<dt>* <code>H5Pset(get)_sieve_buf_size</code>
<dd>The <code>size</code> parameter has changed from type
<code><em>hsize_t</em></code> to
<code><em>size_t</em></code>.
<dt>* <code>H5Pset(get)_sym_k</code>
<dd>The <code>lk</code> parameter has changed from type
<code><em>int</em></code> to
<code><em>unsigned</em></code>.
<dt>* <code>H5Sget_select_bounds</code>
<dd>The <code>start</code> and <code>end</code> parameters have
changed from type <code><em>hsize_t *</em></code>
to <code><em>hssize_t *</em></code> to better match the
rest of the dataspace API.
<dt>* <code>H5Zregister</code>
<dd>This function is substantially revised in Release 1.6.0 with
a new <code>H5Z_class_t</code> struct and
new <i>set local</i> and <i>can apply</i> callback functions.
<dt>&nbsp;
<dt>Fortran90 functions:
<dt><code>h5pset(get)_fapl_core_f</code>
<dd>The 'backing_store' parameter has changed from
<code>INTEGER</code> to <code>LOGICAL</code> to match better C API
<dd>The <code>backing_store</code> parameter has changed from
<code><em>INTEGER</em></code> to <code><em>LOGICAL</em></code>
to better match the C API.
<dt><code>h5pset(get)_preserve_f</code>
<dd>The 'flag' parameter has changed from
<code>INTEGER</code> to <code>LOGICAL</code> to match better C API
<dt><code>H5function</code>
<dd>Description of change
<dd>The <code>flag</code> parameter has changed from
<code><em>INTEGER</em></code> to <code><em>LOGICAL</em></code>
to better match the C API.
</dl>
</dir>
<p>
Backward compatibility with the Release 1.4.x syntax is available
for the functions indicated above with a leading asterisk (*).
The backward compatibility features are available only when the
HDF5 library is configured with the flag
<code>H5_WANT_H5_V1_4_COMPAT</code>,
is not enabled in the binaries distributed by NCSA, and
will eventually be removed from the HDF5 distribution.
<h3>Constants with Changed Values</h3>
</dir>
<p>&nbsp;
<h2>Release 1.4</h2>
<h2>Release 1.4.5 versus Release 1.4.4</h2>
<dir>
<h3>C Library</h3>
<dir>
<b>Added functions:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
<pre>
herr_t H5Pset_fapl_mpiposix(hid_t fapl_id, MPI_Comm comm);
herr_t H5Pget_fapl_mpiposix(hid_t fapl_id, MPI_Comm *comm/*out*/);
</pre>
</td></tr>
</table>
</dir>
<b>Changed functions:</b>
<dir>
The following functions have changed behavior.
<p>
<table border=0>
<tr valign=top align=left><td>
<code>H5Pset_fapl_mpio&nbsp;&nbsp;</code><br>
<code>H5Pget_fapl_mpio</code><br>
<code>H5Fcreate</code><br>
<code>H5Fopen</code><br>
<code>H5Fclose</code>
</td><td>
Previously, the Communicator and Info object arguments supplied
to <code>H5Pset_fapl_mpio</code> were stored in the property with
its handle values.
This meant changes to the communicator or the Info object
after calling <code>H5Pset_fapl_mpio</code> would affect the how
the property list functioned.
This was also the case when <code>H5Fopen/create</code> operated.
They just stored the handle value. This is not according to the
MPI-2 defined behavior of how Info objects should be handled.
(MPI-2 defines Info objects must be parsed when called.)<br>
<code>H5Pset_fapl_mpio</code> now stores a duplicate of each of
the communicator and Info object.<br>
<code>H5Pget_fapl_mpio</code> now returns a duplicate of its
stored communicator and Info object.
It is now the responsibility of the applications to free
those objects when done.<p>
<code>H5Fcreate</code> and <code>H5Fopen</code> also store
a duplicate of the communicator and Info
object supplied by the file access property List.
<code>H5Fclose</code> frees the duplicates.<p>
Advice to users: User applications should release the communicator and
Info object returned by <code>H5Pget_fapl_mpio</code> when they are
no longer needed.
</td></tr>
</table>
</dir>
<b>Removed functions:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
None
<!--
<pre>
List deleted function(s) here. Remove forced spaces. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
-->
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- List deleted function(s) here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td></tr>
</table>
</dir>
There were no other public API changes in the C library for this release.
</dir>
<h3>Fortran90 Library</h3>
<dir>
The following missing Fortran functions were added:
<br>
<br>
<code> h5get_libversion_f, h5check_version_f, h5garbage_collect_f, h5dont_atexit_f </code>
<br>
<code> h5tget_member_index_f, h5tvlen_create_f </code>
<br>
<code> h5dget_storage_size_f, h5dvlen_get_max_len_f , h5dwrite_vl_f, h5dread_vl_f</code>
<br>
<br>
Only <code>integer, real</code> and
<code>character</code> types are supported for VL datatypes.
</dir>
</dir>
<!-- Document API CHANGES ONLY in this file. -->
<h2>Release 1.4.4 versus Release 1.4.3</h2>
<dir>
<h3>C Library</h3>
<dir>
<b>Added functions:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
<pre>
H5Pget_small_data_block_size
H5Pset_small_data_block_size
H5Tget_member_index
</pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- List added function(s) here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td></tr>
</table>
</dir>
<b>Changed functions:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
None
<!--
<pre>
List deleted function(s) here. Remove forced spaces. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
-->
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- List deleted function(s) here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td></tr>
</table>
</dir>
<b>Removed functions:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
None
<!--
<pre>
List deleted function(s) here. Remove forced spaces. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
-->
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- List deleted function(s) here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td></tr>
</table>
</dir>
There were no other public API changes in the C library for this release.
</dir>
<h3>Fortran90 Library</h3>
<dir>
<code>h5dwrite_f, h5dread_f, h5awrite_f, h5aread_f </code>were overloaded
with <code>dims</code> argument to be assumed size array of type <code>INTEGER(HSIZE_T).</code>
We recommend to use the subroutines with the new type. Module subroutines
that accept <code>dims</code> as <code>INTEGER</code> array of size <code>7</code> will be deprecated in the 1.6.0 release.
</dir>
</dir>
<h2>Release 1.4.3 versus Release 1.4.2</h2>
<dir>
<h3>C Library</h3>
<dir>
<b>Removed function:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
<pre>
H5Pset_fapl_dpss </pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- new deleted functions here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- new deleted functions here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td></tr>
</table>
</dir>
There were no other public API changes in the C library for this release.
</dir>
<h3>Fortran90 Library</h3>
<dir>
There were no changes to the public Fortran90 APIs for this release.
</dir>
</dir>
<h2>Release 1.4.2 versus Release 1.4.1</h2>
<dir>
<h3>C Library</h3>
The HDF5 Release 1.4.2 C library is a "Bugfix Release";
there are no API changes in the underlying HDF5 library.
<h3>Fortran90 Library</h3>
The following functions in the HDF5 Release 1.4.2 Fortran90 library
have an additional parameter, <code>dims</code>, that was not present
in Release 1.4.1:
<dir>
<pre>
<font color=red>h5aread_f</font>(attr_id, memtype_id, buf, dims, hdferr)
<font color=red>h5awrite_f</font>(attr_id, memtype_id, buf, dims, hdferr)
<font color=red>h5dread_f</font>(dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, &
file_space_id, xfer_prp)
<font color=red>h5dwrite_f</font>(dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, &
file_space_id, xfer_prp)
</pre>
</dir>
The <code>dims</code> parameter enables library portability
between the UNIX and Microsoft Windows platforms.
</dir>
<h2>Release 1.4.1 versus Release 1.4.0</h2>
<dir>
Release 1.4.1 is a "Tools Release"; there are no API changes in the
underlying HDF5 library.
</dir>
<h2>Release 1.4.0 versus Release 1.2.2</h2>
<dir>
Note: Changes at the subrelease level, i.e., 1.4.1, 1.4.2, ..., are
summarized in the Release 1.4.x version of this document; they are not
reported here.
Several functions were added to or removed from the HDF5 library
in the development of Release 1.4.
in the development of Release 1.4.0.
A few functions have been modified in minor ways.
<h3>New Functions</h3>
The following functions are new for Release 1.4 and are included in the
The following functions are new for Release 1.4.0 and are included in the
<a href="../RM_H5Front.html"><cite>HDF5 Reference Manual</cite></a>.
<dir>
@ -490,7 +798,7 @@ int <font color=red>H5Tget_array_ndims</font> (hid_t adtype_id)
<p>
The following functions are new for Release 1.4, but
The following functions are new for Release 1.4.0, but
are intended only for use in specialized environments.
These are also included in the
<a href="../RM_H5Front.html"><cite>HDF5 Reference Manual</cite></a>.
@ -508,7 +816,7 @@ herr_t <font color=red>H5Pset_fapl_srb</font> (hid_t fapl_id, SRB_Info info);
<p>
The following functions are new for Release 1.4 but are intended
The following functions are new for Release 1.4.0 but are intended
only for driver development work, not for general use.
They are listed in the
<a href="../TechNotes/VFLfunc.html"><cite>List of VFL Functions</cite></a>
@ -588,7 +896,7 @@ H5Tinsert_array
</td></tr>
</table>
</dir>
Note that the entire H5RA interface, an esperimental interface for
Note that the entire H5RA interface, an experimental interface for
ragged arrays, has been removed from the library.
@ -617,37 +925,87 @@ H5Tinsert_array
</dir>
<p>&nbsp;
<h2>Migration from Release 1.2.2 to Release 1.4.<em>x</em></h2>
<h2>This and Prior Releases: The RELEASE and HISTORY Files</h2>
<dir>
<h3>H5Tinsert_array</h3>
The functionality of <code>H5Tinsert_array</code> has been replaced by
<code>H5Tarray_create</code>.
Here is an example of changing code from <code>H5Tinsert_array</code>
to <code>H5Tarray_create</code>.
<pre>
V1.2.2
{
struct tmp_struct {
int a;
float f[3];
double d[2][4];
};
size_t f_dims[1]={3};
size_t d_dims[2]={2,4};
hid_t compound_type;
compound_type=H5Tcreate(H5T_COMPOUND,sizeof(struct tmp_struct));
H5Tinsert(compound_type,"a",HOFFSET(struct tmp_struct,a),H5T_NATIVE_INT);
H5Tinsert_array(compound_type,"f",HOFFSET(struct tmp_struct,f),1,f_dims,NULL,H5T_NATIVE_FLOAT);
H5Tinsert_array(compound_type,"d",HOFFSET(struct tmp_struct,d),2,d_dims,NULL,H5T_NATIVE_DOUBLE);
}
V1.4.0
{
struct tmp_struct {
int a;
float f[3];
double d[2][4];
};
hsize_t f_dims[1]={3};
hsize_t d_dims[2]={2,4};
hid_t compound_type;
hid_t array_type;
compound_type=H5Tcreate(H5T_COMPOUND,sizeof(struct tmp_struct));
H5Tinsert(compound_type,"a",HOFFSET(struct tmp_struct,a),H5T_NATIVE_INT);
array_type=H5Tarray_create(H5T_NATIVE_FLOAT,1,f_dims,NULL);
H5Tinsert(compound_type,"f",HOFFSET(struct tmp_struct,f),array_type);
H5Tclose(array_type);
array_type=H5Tarray_create(H5T_NATIVE_DOUBLE,2,d_dims,NULL);
H5Tinsert(compound_type,"d",HOFFSET(struct tmp_struct,d),array_type);
H5Tclose(array_type);
}
</pre>
</dir>
<h2>This and Prior Releases: The RELEASE.txt and HISTORY.txt Files</h2>
<dir>
The HDF5 source code, as distributed to users and developers,
contains two files that will be of interest to readers of this
document. Both files are located at the top level of the
source code tree (i.e., in <code>.../hdf5/</code>) and are
duplicated here for your reference:
source code tree and are duplicated here for your reference:
<p>
<dl>
<dt><a href="RELEASE.txt" target="ExtWin">RELEASE</a>
<dt><a href="RELEASE.txt" target="ExtWin">RELEASE.txt</a>
<dd>Technical notes regarding the release, including
new features and the changes since the last release,
notes regarding new or revised utilities,
notes regarding alternative language APIs (Fortran90, C++),
bugs fixed since the last release,
platforms on which the release has been tested,
and
platforms on which the release has been tested, and
known problems.
This is the file commonly known among developers as
"the release notes."
This is the file commonly known as "the release notes."
<p>
<dt><a href="HISTORY.txt" target="ExtWin">HISTORY</a>
<dt><a href="HISTORY.txt" target="ExtWin">HISTORY.txt</a>
<dd>A release-by-release history of the HDF5 library.
This file is a compiled set of the release notes
(i.e., the RELEASE files) from prior releases.
(i.e., the RELEASE.txt files) from prior releases.
<dl>
</dir>
<!-- #BeginLibraryItem "/ed_libs/NavBar_ADevG.lbi" --><hr>
<center>
<table border=0 width=98%>
@ -674,7 +1032,7 @@ Describes HDF5 Release 1.5, Unreleased Development Branch
<!-- Created: Spring 1999 -->
<!-- hhmts start -->
Last modified: 25 June 2003
Last modified: 2 July 2003
<!-- hhmts end -->
</body>