Purpose:
This version updates the procedure for creating PDF versions of
HDF5 documents to reflect the use of Macromedia DreamWeaver and
HTMLdoc. process.txt describes the current RM process in detail;
the very similar UG process will be described later.
Purpose:
This file describes the process for creating the PDF versions of
HDF5 documents. The file being checked in now is the original
version (November 1999) from when hte process used MS Word.
Platforms tested:
This process was tested by using it to guide the production process
for at least 2 releases.
Bugfixes in H5Pget/set_fclose_degree
Clarification in H5Pset_filter
Description:
H5Pget_fclose_degree and H5Pset_fclose_degree
Functions index at top of page:
Move H5Pget/set_fclose_degree into "File Access Properties."
Remove "File Close Properties" section.
H5Pget_fclose_degree -- Correct parameter description.
(Contribute to closing Bugzilla entries 188 and 190.)
H5Pset_filter -- Clarification of terms
Other minor formatting and copy edits.
Platforms tested:
Mozilla
Description:
H5T_conv_t (appears in H5Tregister description) -- changed datatype
of the nelmts parameter
H5Tconvert -- changed datatype of the nelmts parameter
Platforms tested:
Mozilla
Purpose:
In "Intro to HDF5" Example #5, corrected the anticipated output listed in
a code comment.
Fixes Bugzilla entry #112.
Platforms tested:
Mozilla
Purpose:
Removed second versions of h5dread_f and h5dwrite_f, as that version
of the FORTRAN subroutine is no longer required and has been removed
from the API.
This closes Bugzilla entry #92, which complained of a parameter
description error in the second version.
Platforms tested:
Mozilla
update documentation and usage message
Description:
updated the html documentation for the new h5diff modes
added a section for h5repack
Solution:
Platforms tested:
linux
Misc. update:
Purpose:
Bug Fix
Description:
If an HDF5 file grows larger than its address space, it dies and is unable to
write any data. This is more likely to happen since users are able to change
the number of bytes used to store addresses in the file.
Solution:
HDF5 now throws an error instead of dying. In addition, it "reserves" address
space for the local heap and for object headers (which do not allocate space
immediately). This ensures that after the error occurs, there is enough address
space left to flush the entire file to disk, so no data is lost.
A more complete explanation is at /doc/html/TechNotes/ReservedFileSpace.html
Platforms tested:
sleipnir, copper (parallel), verbena, arabica, Windows (Visual Studio 7)
Solution:
Platforms tested:
Misc. update:
Purpose: Maintenance
Description: H5_SZIP_CHIP_OPTION_MASK was deleted from the list
of the available parameters for the H5Pset_szip function.
Solution: Updated Fortran source, tests and documentation
to reflect this change.
Platforms tested: arabica (too small for h5committest)
Misc. update:
Purpose:
To more carefully describe the
-- behavior of H5Pset_external
-- appropriate usage of H5Pset_shuffle
Description:
H5Pset_external
Add notes that first H5Pset_external call sets the dataset as EXTERNAL
and identifies the first file in the series of external files that
will hold the dataset; subsequent calls identify additional files;
all external files must be declared before the dataset is created;
and the library will create files that don't yet exist on the system
at the time that H5Dwrite is called to write data to that file.
H5Pset_shuffle
Added notes regarding usage of H5Pset_shuffle in concert with a
compression filter.
And, as always, a few copy edits.
Purpose:
SZIP and more general filter updates
Description:
Added SZIP to the introductory paragraphs and as appropriate in
the Fortran subroutine descriptions.
Revised the introductory discussion, which had previously focussed
on one compression filter, to allow for multiple filters of
different types.
Added list of filters currently distributed with HDF5 to intro.
Also some copy edits and minor formatting.
Platforms tested:
Mozilla, Safari
Purpose:
Hide 'changes in this release' section, which is now in the _AD_Guide_
and is no longer maintained in this document.
Platforms tested:
Mozilla
Purpose:
To include new functionality.
Description:
Added twelve new functions:
H5Iregister H5Iclear_type
H5Iregister_type H5Iget_type_ref
H5Idestroy_type H5Iget_file_id
H5Iremove_verify H5Inmembers
H5Iobject_verify H5Idec_type_ref
H5Isearch H5Iinc_type_ref
This is a checkin for technical content;
an editorial checkin will follow, though not immediately.
Platforms tested:
Mozilla, IE, Safari
Code optimization & bug fix
Description:
When dimension information is being stored in the storage layout message
on disk, it is stored as 32-bit quantities, possibly truncating the dimension
information, if a dimension is greater than 32-bits in size.
Solution:
Fix the storage layout message problem by revising file format to not store
dimension information, since it is already available in the dataspace.
Also revise the storage layout data structures to be more compartmentalized
for the information for contiguous, chunked and compact storage.
Platforms tested:
FreeBSD 4.9 (sleipnir) w/parallel
Solaris 2.7 (arabica)
h5committest
Purpose:
Bugfixes in H5Gset_comment, h5gget_comment_f, and h5gset_comment_f.
(Follow-on to the H5Gget_comment bugfix of last week.)
Description:
Changed C parameter descriptions to indicate the following:
'loc_id' can be file, group, dataset, or named datatype.
'name' can be '.' if 'loc_id' fully describes the object.
'name' is ignored if 'loc_id' is a dataset or named datatype.
Modified h5gget_comment_f and h5gset_comment_f notes accordingly.
Copy edits in H5Gget/set_comment and h5gget/set_comment_f.
Platforms tested:
Safari
Purpose:
H5Gget_comment bugfix
Description:
H5Gget_comment: Changed "Description" text and "Parameters"
descriptions to indicate the following:
'loc_id' can be file, group, dataset, or named datatype.
'name' can be '.' if 'loc_id' fully describes the object.
'name' is ignored if 'loc_id' is a dataset or nemed datatype.
Also corrected the fact that the 'name' parameter description
referred to setting the comment rather than retriving it.
Platforms tested:
Safari
Purpose:
Clean up RM formatting.
Modify RM HTML code to facilitate automated generation of PDF version.
Minor edits.
Description:
Reworked format of "Options" and "Parameters" sections.
Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to
generate PDF files.
Other minor copy edits.
Platforms tested:
IE 5
Purpose:
Bugfix: Bugzilla #66
Solution:
H5Pset_szip -- Corrected the plist parameter description.
Since this property can be set only in the dataset
creation property list, changed the parameter description
from
Dataset creation or dataset transfer property list identifier.
to
Dataset creation property list identifier.
Fixes Bugzilla bug #66.
Platforms tested:
IE 5
Purpose:
Clean up RM formatting.
Modify RM HTML code to facilitate automated generation of PDF version.
Minor edits.
Description:
Reworked format of "Parameters" sections.
Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to
generate PDF files.
Fixed the "Copyright" link on RM_H5Front.html.
Other minor copy edits.
Platforms tested:
IE 5
Purpose:
replaced name of delete filter with remove filter for the new function H5Premove_filter
Description:
Solution:
Platforms tested:
linux
Misc. update:
Bug fix/optimization
Description:
Address slowdown in MPI-I/O file metadata operations that was introduced
mid-stream. We now _require_ a POSIX compliant parallel file system for the
MPI-I/O file driver (as well as for the MPI-POSIX file driver).
Also optimized file open operation when the file is being created by
reducing the number of collective & syncronizing calls.
Additionally, refactor the MPI routines into a common place, eliminating
duplicated code.
Platforms tested:
FreeBSD 4.9 (sleipnir) w/parallel
h5committest
Code cleanup
Description:
Add C++ and FORTRAN wrappers for new H5Pdelete_filter routine, along with
documentation and a note in the release notes.
Platforms tested:
FreeBSD 4.9 (sleipnir)
Linux 2.4 (verbena) w/ C++ and FORTRAN
Too minor for full h5committest
Bug fix
Description:
When two property lists are compared, the H5Pequal routine was just
comparing the raw information for the property values. This causes problems
when the raw information contains pointers to other information.
Solution:
Allow a 'compare' callback to be registered for properties, so that a user
application get perform the comparison itself, allowing for "deep" compares of
the property value.
This was exported to the H5Pregister & H5Pinsert routines in the development
branch, but not the release branch.
Platforms tested:
FreeBSD 4.9 (sleipnir)
h5committest
Purpose:
Fixes for user-reported Ref Manual bugs:
H5Gget_objname_by_idx: corrected 'size' parameter specification
H5Sselect_elements: Expanded 'coord' parameter description to make it
clear that values are 0-based.
Additional minor copy edits and formatting cleanup.
Platforms tested:
IE 5
Bug fix
Description:
Correct list of files to install after recent FORTRAN documentation cleanup
Platforms tested:
FreeBSD 4.9 (sleipnir) w/"make install-doc"
h5committest doesn't test this.
Purpose:
Removing the files
hdf5/doc/html/fortran/h5*_FORTRAN.html
from CVS as the content has been integrated into the files
hdf5/doc/html/RM_H5*.html
Purpose:
Glossary.html only: Clean up nesting of HTML tags
Glossary.html and PredefDTypes.html
Add HTML code that facilitates creating PDF version of RM
Description:
Solution:
Platforms tested:
Safari, IE 5
