Purpose:
Second phase of development of doc.
Description:
Added lists of new, deleted, and changed functions.
Added list of constants with changed values.
Changed doc title.
Platforms tested:
IE 5
Purpose:
A bugfix and a new document
Description:
ADGuide/Changes.html
New document: "HDF5 Library Changes from Release to Release"
(MUST be updated at EVERY release, including Betas.)
ADGuide/ImageSpec.html
Fixed broken links and title tag.
Platforms tested:
IE 5
Purpose:
Bugfix and adding a new document
Description:
RM_H5Front.html
Removed a currently commented-out section that had been used
during the 1.2 period for separate F90 releases.
ADGuide.html
Added new "Changes from Release to Release" document.
Fixed title tag.
Platforms tested:
IE 5
Purpose:
Correcting docs to match code bugfixes.
Solution:
Changed per recent bugfix in code:
H5Tconvert 'nelmts' parameter type
H5Pset_buffer 'size' parameter type
H5Pget_buffer return type
Purpose:
To make C++ and Fortran90 API docs more accessible
Solution:
Added link to C++ and Fortran90 API docs to docs index page.
Platforms tested:
IE 5
Purpose:
Bug fix (unreported bug)
Description:
H5Pset_fapl_core, H5Pget_fapl_core
Completed entries for these two functions. (They had
been added structurally, but details had been omitted.)
Platforms tested:
IE 5
Purpose:
Error in H5Tget_array_dims and H5Tget_array_ndims return types
Solution:
H5Tget_array_dims and H5Tget_array_ndims
Fixed return value to read 'int' (was 'int *')
Platforms tested:
IE 5
Purpose:
Checking in MountingFiles.html and Performance.html.
These documents were originally created in 1.2 branch and never
checked in to the development branch.
Platforms tested:
IE 5
Purpose:
Bugfix -- #446
Description:
H5Tget_offset has been fixed so that it returns a negative value
on failure. This is now reflected in RM.
Platforms tested:
IE 5
Purpose:
CppUserNotes.pdf
CppUserNotes.doc (not for distribution)
CppInterfaces.html
New C++ API documents -- "HDF5 C++ User's Notes"
and "HDF5 C++ Interfaces"
Platforms tested:
IE 5
Purpose:
Linking the new "Predefined Dataypes" document into the RM.
Description:
Added PredefDTypes.html link into all RM files.
Platforms tested:
IE 5
Purpose:
Finalize new API function descriptions
Description:
Edits to recently-added APIs:
H5Pset_sieve_buf_size H5Pset_fapl_log
H5P[sg]et_fapl_mpio H5Pset_fapl_multi
H5P[sg]et_dxpl_multi H5Pset_fapl_split
H5P[sg]et_fapl_gass H5Pset_fapl_dpss
H5P[sg]et_fapl_srb
Added H5P[sg]et_fapl_core.
Addition of new APIs for R1.4 is now complete.
Moved H5Pset_driver and H5Pget_driver_info to TechNotes.
Platforms tested:
IE 5
New doc and update
Description:
The original openmp-hdf5.html contains a bunch of C source code.
HTML does not like source code, especially C-code that contained
<...>. It gobbled it badly.
Solution:
Moved the source code to a new file, openmp-hdf5.c and make a
reference to it from openmp-hdf5.html.
Platforms tested:
Viewed via IE on an NT box.
Corrections & updates
Description:
Updated and corrected DDL description & examples to include all the
current features for the v1.4 release. Lots of changes...
Platforms tested:
Netscape 4.76
Addtion
Description:
Added variable length datatypes to the DDL and put an example in
the "example" thingy at the bottom.
Doo dah doo dah.
Platforms tested:
w3m
Clean up formatting and delete two functions.
Description:
Minor reformatting at the head of each file (in the functions list).
Delete 2 functions from HM_H5T.html -- H5Tget_member_dims, H5Tinsert_array.
Platforms tested:
IE 5.
To warn users that RM_H5G.html and Groups.html can render groups and
datasets inaccessible in a file.
Solution:
Modified RM_H5G.html and Groups.html as follows:
-- Added warning (new section) to Groups.html that H5Gunlink and
H5Gmove can result in inaccessible groups and datasets.
-- Added links to that new section from H5Gunlink and H5Gmove
in RM_H5G.html.
Platforms tested:
IE5
Purpose:
Removing functions that have been removed from library.
Solution:
Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2,
H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family,
H5P[gs]et_mpi, and H5P[gs]et_xfer.
Platforms tested:
IE5
"New" document
Description:
Raymond has prepared and added a new document reporting his
experience of using HDF5 with OpenMP. It was checked in as
a .txt file but browsers could not display it properly, at least
not for the MS-IE.
Solution:
I renamed the file from openmp-test.txt to openmp-hdf5.html,
added in simple mind html control statement (<pre>), added
an entry to the TechNote.html so that it can be found with
other technical notes.
Platforms tested:
Viewed by MS-IE.
Documentation of TS Library
Description:
This is the document Chee Wai wrote up about the thread safe
version of the HDF5 library. I just put it in HTML format and
checked it in...
Platforms tested:
Netscrape
Purpose:
This file describes the experiencing of OpenMP with hdf5.
Description:
All detailed description is in the file.
Solution:
[details about the changes, algorithm, etc...]
[Please as detail as you can since your own explanation is
better than others guessing it from the code.]
Platforms tested:
Everything was done on modi4.
Feature symmetry
Description:
A while ago I needed to get the 'type' of data being accessed during writes
to the VFL driver, so I put in code to get the information down there.
Albert asked for the same information during reads, so I've added that in.
Tested:
Netscape
Bug Fix
Description:
the line:
#include <hdf5.h>
needed to be escaped to be seen in the browser.
Solution:
Changed to:
#include <hdf5.h>
Platforms tested:
Seen in Netscrape
Adding new document links
Description:
Adding links to TechNotes/VFL.html and TechNotes/VFLfunc.html,
the new virtual file layer documents.
Platforms tested:
IE 5
Adding new document
Description:
Adding VFL.html (Virtual File Layer) to HDF5 Technical Notes.
August 1999 version. Will be updated for R1.4 by developer.
Platforms tested:
IE 5
Purpose:
Clarification of H5Fclose
Description:
RM_H5F.html / H5Fclose: Added note that all data is flushed to file.
Platforms tested:
Tested with IE 5.
Bug fix
Description:
The documentation on how to dump attribute data was not complete
enough. Some people got confused on the commandline syntax (you
have to specify the "path" from the root group to the attribute
to dump it). I put some examples in to show how to correctly dump
attributes.
Platforms tested:
Viewed with Netscrape.
Update
Description:
Added the description of the environment variable HDF5_MPI_OPT_TYPES
which controls the use of optimized MPIO routines.
Platforms tested:
Viewed via IE.
Purpose:
Bug fix -- #445
Description:
In RM_H5D.html in the H5 Reference Manual, the H5Dget_storage_size
entry described the wrong FAILURE return value.
Solution:
Changed H5Dget_storage_size return value on FAILURE to 0 (zero).
Platforms tested:
Tested in Internet Explorer 5.
Feature
Description:
Added a new document of all the controls (compiler macros,
environment variables, ...) that affect the functionality of
the libraries and tools.
Platforms tested:
Viewed with MS IE.
RM_H5Front.html
Added new Fortran90 functions and links. Related edits.
Added "Describes HDF5 Release..." line in page footers.
Minor editorial corrections.
H5Tvlen_create: Added cross-reference to H5Dget_vlen_buf_size
and H5Dvlen_reclaim.
H5Tget_class: Removed numbers from class identifiers list.
Added H5T_VLEN to class identifiers list.
RM_H5F.html
H5Freopen: Corrected description of file_id parameter.
Added comment about eventually closing returned identifier.
Added clarification that function cannot open closed files.
H5Pget_chunk: Changed max_ndims parameter description to IN.
H5Pget/set_gc_references: Corrected signature errors,
added missing parameter description and values.
H5Pget/set_family: Removed. These are not implemented.
H5Pget/set_hyper_cache: Corrected signature and parameter
expressions, added missing parameter description.
H5Pset_buffer: Added units for parameter 'size'.RM_H5P.html
H5Pget/set_split: Corrected misnamed parameters.
H5Pset_alignment and H5_set_core:
Edited for clarity.
Added statement regarding "special case" effect of
setting 'threshold' to 0 (zero).
Stated clearly that 'threshold' is non-negative and
'alignment' and 'increment' are both positive.
H5Pget/set_vlen_mem_manager:
Corrected cross-ref to H5Dvlen_reclaim.
Minor clarification regarding circumstances under which
contents of a parameter are ignored.
H5Pget_cache: Removed redundant material.
Removed H5Pset_compression (commented it out, actually) and
changed example which used it to use H5Pset_deflate.
H5.format.html
Driver Identification block: Added clarification regarding the
representation of the version in the driver identification string.
H5Dclose: Corrected return type to herr_t (was hid_t).
H5Dcreate: Inserted missing spaces in function syntax statement.
RM_H5E.html
H5Ewalk: Added H5E_walk_t prototype and prototype parameter
descriptions.
RM_H5F.html
H5Fclose: Corrected behavior description, eliminating
comment that function fials if other access identifiers
are still open and describing actual behavior.
RM_H5T.html
H5Tregister: Corrected possible 'pers' values to H5T_PERS_HARD
(was HARD) and H5T_PERS_SOFT (was SOFT).
H5Tfind: Corrected 'pcdata' parameter IN/OUT designation.
Groups.html
Added note that object names (in Groups.html) or dataset
names (in Datasets.html) must be unique.
Changed 'boot block' to 'super block'. (Groups.html only)
Files.html
Minor formatting fixes.
Datatypes.html
H5Tconvert: Added plist_id parameter.
References.html
Deleted "not implemented" and related messages.
Added description of H5Rget_object_type.
Deleted all material about internal dataset region references.
[Unlikely to be implemented (QK) and there was very little info.]
Commented out references to H5R_BADTYPE. [This appeared in the
list of "valid types", which it is not. And user is instructed
to test for 'a negative value' rather than 'H5R_BADTYPE'.
So this was deemed not to be user-level information.]
Changed 'boot block' to 'super block'.
Other minor editing changes.
H5Dopen: Corrected description of 'loc_id' parameter.
RM_H5T.html
H5Tset_strpad:
Corrected string padding values list (replaced 'H5T_STR_NULL &
H5T_STR_SPACE' with ''H5T_STR_NULLTERM, 'H5T_STR_NULLPAD, &
H5T_STR_SPACEPAD'.
Added notes re conversion from shorter to longer strings and
from longer to shorter strings.
Other minor edits and formatting.
H5Tget_class
Corrected H5T_ENUM and H5T_REFERENCE entries in class
identifiers table (they were reversed).
Tools.html
h5dump: Added note that '-bb' option is not yet implemented.
Changed 'boot block' to 'super block'.
Corrected link to HDF5 FTP archives.
H5.intro.html
Added paragraph stating that changes in bugfix Releases 1.2.x
are listed in the RELEASE, HISTORY, and README files.
