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
Purpose:
Add pointer to location where PDF version of RM will be posted shortly
In the Fortran90 introductory text:
remove text describing presentation of F90 descriptions on
separate HTML pages
otherwise update discussion
Platforms tested:
IE 5, Safari
Description:
Integrate Fortran90 function descriptions
Remove "Non-C APIs" sections; add "Fortran90 Interface" sections
Remove note that Fortran APIs are described in a separate window
Add h5pset/get_fapl_mpiposix_f
Reinstate H5Pget_hyper_vector_size (previously removed in error)
Remove H5Pget_hyper_cache (function deprecated in 1.6, removed in 1.8)
Minor copy edits and formatting
Platforms tested:
IE 5, Safari
Purpose:
Integrate Fortran90 function descriptions
Remove "Non-C APIs" sections; add "Fortran90 Interface" sections
Remove note that Fortran APIs are described in a separate window
Platforms tested:
Safari
Purpose:
Integrate Fortran90 function descriptions
Remove "Non-C APIs" sections; add "Fortran90 Interface" sections
Remove note that Fortran APIs are described in a separate window
Touch up function index
Minor format fixes and copy edits
Platforms tested:
Safari
Description:
Integrate Fortran90 function descriptions
Remove "Non-C APIs" sections; add "Fortran90 Interface" sections
Remove note that Fortran APIs are described in a separate window
Platforms tested:
Safari
Description:
Integrate Fortran90 function descriptions
Remove "Non-C APIs" sections; add "Fortran90 Interface" sections
Remove note that Fortran APIs are described in a separate window
Platforms tested:
Safari
Description:
Integrate Fortran90 function descriptions
Remove "Non-C APIs" sections; add "Fortran90 Interface" sections
Remove note that Fortran APIs are described in a separate window
Corrected H5Gget_objname_by_idx return value description
Platforms tested:
Safari
Description:
Integrate Fortran90 function descriptions
Remove "Non-C APIs" sections; add "Fortran90 Interface" sections
Remove note that Fortran APIs are described in a separate window
Add H5Fget_freelist/h5fget_freelist_f
Platforms tested:
Safari, IE 5
Description:
Fortran90 integration cleanup pass
Removed note that Fortran APIs are described in a separate browser window
Platforms tested:
IE 5, Safari
Purpose:
Expand H5open/h5open_f and H5close/h5close_f descriptions
to indicate that these two calls are mandatory in Fortran90
applications (though optional in C).
Platforms tested:
IE 5, Safari
Purpose: Bug fix
Description: The third parameter to the h5pget(set)_cache_f subroutines
had a wrong type
Solution: Fixed the type and changed the docs.
Platforms tested: kelgia, arabica 64-bit, copper 64-bit
Misc. update:
Purpose:
Alphabetic sort of RM function entries
Additional and modified HTML coding to accomodate HTMLdoc and
automated PDF generation
Function index formatting
Platforms tested:
IE 5, Safari
Purpose:
Alphabetic sort of RM function entries
Additional and modified HTML coding to accomodate HTMLdoc and
automated PDF generation
Minor copy edits
Platforms tested:
IE 5, Safari
Purpose:
Alphabetic sort of RM function entries
Additional and modified HTML coding to accomodate HTMLdoc and
automated PDF generation
Corrected link to the F90 subroutine h5rget_object_type_f from the
H5Rget_obj_type function description
Platforms tested:
IE 5, Safari
Purpose:
Alphabetic sort of RM function entries
Additional and modified HTML coding to accomodate HTMLdoc and
automated PDF generation
Minor copy edits
Platforms tested:
Safari, IE 5
Purpose:
Alphabetic sort of RM function entries
Additional and modified HTML coding to accomodate HTMLdoc and
automated PDF generation
Description:
Solution:
Platforms tested:
Misc. update:
Added the entry of document of the three basic performance tools.
The information was provided by Robb long time ago.
Platforms tested:
Viewed by IE.
Misc. update:
Code cleanup, etc.
Description:
Generalize Ray's datatype fixes to handle packing compound datatypes which
are the base type of an array or variable-length type, etc.
Also track "packedness" of a compound datatype from it's creation, instead
of only setting the 'packed' flag after the datatype was explicitly packed.
Updated docs to reflect that a compound datatype is allowed to grow (but
not shrink).
Platforms tested:
FreeBSD 4.9 (sleipnir)
h5committest
Bug Fix and code cleanup
Description:
Correct error in H5T_detect_class that was causing nested compound datatypes
with to not detect the datatype class of fields correctly, which caused errors
with fill-values, variable-length datatypes and chunks later on.
Return the rank of the array datatype from H5Tget_array_dims(), like
H5Sget_dims().
Lots of cleanups to datatype code, to make the handling of arrays, compound
types, variable-length strings and sequences and enumerated types more
consistent and robust.
Platforms tested:
FreeBSD 4.9 (sleipnir)
h5committest
Purpose:
Enhanced indexing; copy edits.
Description:
Restructured index and clarify descriptions and/or make them more
parallel; added link to "Other tools"
Added note that h4toh5 and h5toh4 are no longer part of the HDF5 library
distribution
Lots of copy edits
Platforms tested:
IE 5, Safari
Bug fix
Description:
H5Gget_objname_by_idx should allow NULL for the 'name' parameter, to allow
for querying for the name's length.
Solution:
Allow NULL for the 'name' parameter, the internal functions were already
ready to handle that case.
Clean up RM information about H5Gget_objname_by_idx and
H5Gget_objtype_by_idx also.
Platforms tested:
FreeBSD 4.8 (sleipnir)
h5committest
Description:
Checking in Version 2 of this specification, which was done
in July 2002. It should have been in the doc tree a long time
ago.
Solution:
Platforms tested:
Misc. update:
Purpose:
Changed "HDF5 User's Guide" links (in navigation bars, primarily)
to point to new user's guide, which will reside for a while yet on
the HDF server.
The old user's guide will still go out with the distribution under
the label "HDF5 User's Guide, Release 1.4.5."
Platforms tested:
IE 5
Purpose:
Renamed old "HDF5 User's Guide" as "HDF5 User's Guide, Release 1.4.5".
Added navigation bar link to new user's guide on HDF server.
Changed release tag line (in old UG only) back to
"Describes HDF5 Release 1.4.5, February 200 3"
Platforms tested:
IE 5
Purpose:
Update links.
Add documents.
Description:
Bring in current links and notes from the R1.4.5 document.
Add the documents which have been collected in
http://hdf.ncsa.uiuc.edu/HDF5/doc_resource/.
These documents include discussions of SZIP, generic properties,
the shuffle algorithm and its influence on performance, fill values
and space allocation, and error detection.
Platforms tested:
IE 5
Update information
Description:
Update with more correct information. (Still not finished, but its better
than it was before... :-)
Platforms tested:
Mozilla 1.4.0
Description:
Changed UG link to point to new UG, retaining secondary link to 1.4.5 UG.
Removed pointer to printable documents.
Minor formatting.
Platforms tested:
IE 5
Purpose:
To segregate HDF4/HDF5 conversion tools and add link to H4toH5 Library
Description:
Restructured indexing at the top of the page into these sections:
User utilities
Configuration and library management utilities
Java-based tools
HDF5/HDF4 conversion tools
Added link to http://hdf.ncsa.uiuc.edu/h4toh5/
Platforms tested:
IE 5
Purpose:
Add short copyright notice.
Update release tag line.
Description:
Added short copyright notice as comment in source files;
does not display in browser.
Updated release tag line in footers to read as follows:
Describes HDF5 Release 1.6.0, July 2003
Platforms tested:
IE 5
Purpose:
Add copyright
Update release number
Description:
Added short copyright statement (doc version).
Updated release number and date to Release 1.6.1, July 2003.
Platforms tested:
IE 5
Purpose:
H5Pset/get_hyper_cache are deprecated in R 1..6.0.
Description:
Added notation that H5Pset/get_hyper_cache are deprecated functions
in R1.6.0 and are available only if library is configured for
1.4 compatibility.
Platforms tested:
IE 5
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
Purpose:
Update h5pset_szip_f options mask.
Description:
h5pset_szip_f: Updated list of valid szip option values.
Deleted 2, added 3 and notation "or the sum of any combination".
Added example and note regarding mutually-exclusive options.
Platforms tested:
IE 5
Purpose:
H5Pset_shuffle -- Add note regarding intended use.
H5Pset_szip -- Correct options mask list. Copy edits.
Description:
H5Pset_shuffle -- Added note that the shuffle filter is designed to be
used with in combination a compression filter.
H5Pset_szip -- Changed 'szip' to 'SZIP' in running text.
Removed RAW_OPTIONS_MASK, LSB_OPTIONS_MASK, and MSB-OPTIONS_MASK
from options maks list as they are not available for user control.
Added 'H5_SZIP_' prefix to all remaining option tags.
Made corresponding changes to running text, removing or revising
mentions of deleted option tags.
Platforms tested:
IE 5
Purpose:
Primarily edits from technical review
Description:
H5Dread
H5Dwrite
Clarify library behavior with certain mem_space_id/file_space_id
combinations.
Add comment regarding when space is allocated and fill values written.
H5Dget_space_status -- Correct return value.
Copy edits and formatting fixes.
Platforms tested:
IE 5, Safari
Purpose:
Primarily edits from technical review.
Description:
H5Pget_fill_value -- Corrected 'value' parameter type.
H5Pget_fill_time -- Added H5D_FILL_TIME_IFSET.
H5Pset_filter --Add that filters are applied to chunks in order
in which they were created.
Correct H5Z_FLAG_OPTIONAL description.
Add references to related functions.
Add H5Z_FILTER_SZIP to list of valid filters.
H5Pget_filter -- Add H5Z_FILTER_SZIP to list of possible filters.
H5Pset_szip -- Remove list of publications references.
H5Pset_edc_check -- Reverse notation of default setting.
Copy edits.
Platforms tested:
IE 5, Safari
Purpose:
Complete "compression" to "filters" revisions.
H5Zregister review feedback.
Description:
Intro -- Finish the "Compression" ==> "Filters" changes.
H5Zregister -- Clarify that the can_apply_func and set_local_func
can be set to null.
-- Define value of filter_id
-- Other smaller revisions.
(all based on review feedback)
Platforms tested:
IE 5, Safari
Purpose:
Edits based on review feedback.
Description:
H5Dget_offset -- Corrected return value.
H5Dcreate -- Added a brief mention of "fill values and space allocation"
and a set of cross-references.
H5Dfill -- Added H5Dcreate to the cross-reference list.
Platforms tested:
IE 5, Safari
Purpose:
Edits based on review feedback.
Description:
H5Tis_variable_str
H5Tdetect_class
-- Added notes regarding applicability of these 2 functions.
H5Tget_native_type -- Copy edits.
Added note to close returned identifier with H5Tclose and
clarification WRT array, compoud, etc datatypes.
Misc copy edits.
Platforms tested:
IE 5, Safari
Purpose:
Add new tools:
h5diff
h5perf
h5redeploy
h5c++
Corrections to h5import
Description:
h5diff, h5perf, h5redeploy, h5c++ -- Added these tools.
h5import -- Corrected the description of the naming convention for
output datasets. Other edits based on review comments.
Copy edits and source code formatting.
Platforms tested:
IE 5, Safari
Purpose:
To facilitate finding functions, particularly in long Reference Manual
sections.
Solution:
Added alphabetized function listings. (NOTE: Aside from the H5I and H5Z
sections, this is not necessarily the final implementation; there will
likely be another revision in the presentation of this listing before it
is released.)
Platforms tested:
Safari, IE 5
Purpose:
Make "New Functions and Tools" section easier to read.
Solution:
Alphabetized functions and tools lists.
Created table with function names on left, full syntax on right.
Platforms tested:
Safari, IE 5
API tweak.
Description:
The H5Sget_select_bounds() API call was using hsize_t arrays for retrieving
the 'start' and 'end' coordinates, which is counter to the rest of the dataspace
API.
Solution:
Change the arrays to be hssize_t instead.
Platforms tested:
FreeBSD 4.8 (sleipnir) w/C++
FreeBSD 4.8 (sleipnir) w/parallel
h5committested
Misc. update:
Updated all docs for this change.
Added 1.4 compatibility #ifdef's
Purpose:
Update H5Zregister to describe new approach to filter management.
Description:
H5Zregister -- heavy revisions to reflect new filter-handling approach.
Added H5Z_class_t struct,
H5Z_can_apply_func_t callback function, and
H5Z_set_local_func_t callback function,
and rewrote much of the rest.
Platforms tested:
IE 5, Safari
Purpose:
Correction of a misleading comment.
Description:
h5cc & h5fc
Corrected the same spot in each "Description" where the text,
literally interpreted, implied that HDF5 could be used as a compiler.
Platforms tested:
IE 5, Safari
Purpose:
New feature -- h5fc
Description:
Added h5fc entry.
Took the opportunity to make some relatively minor copy edits and
grammatical corrections in h5cc entry.
Platforms tested:
Safari, IE 5
Purpose:
Add new functions.
Rewrite existing function.
Description:
Added H5get_vfd_handle and H5get_obj_ids.
Rewrote H5get_obj_count: function description was incomplete
and 2 (of 3) parameters were missing.
Platforms tested:
Safari, IE 5
Purpose:
Add new function
Add note regarding intentionally undocumented function
Description:
Added H5Dget_offset.
H5Ddebug -- Added note in HTML-coded comment that this function,
while technically public, is not intended for public use and
should not be listed in the RM.
Platforms tested:
Safari, IE 5
Purpose:
Removed reference to discontinued API
Changes reflecting renamed section of RM
Description:
Removed reference to H5RA, ragged arrays.
Made edits reflecting the H5Z change from "Compression" to
"Filters & Compression."
Platforms tested:
Safari, IE 5
Purpose:
Comment out functions not in R1.6
Description:
Commented out these hyperslab functions since they are not "turned on"
for Release 1.6:
h5scombine_hyperslab_f
h5scombine_select_f
h5sselect_select_f
Platforms tested:
Safari, IE 5
Purpose:
Add new function
Add operands to 2 existing functions
Comment out functions not in R1.6
Description:
H5Sget_select_type -- Added new function.
H5Sselect_hyperslab -- Added operands H5S_SELECT_AND, H5S_SELECT_XOR,
and H5S_SELECT_NOTB, H5S_SELECT_NOTA.
Reformatted part of Description source code, with minor copy-edits.
H5Sselect_elements -- Added operands H5S_SELECT_APPEND, H5S_SELECT_PREPEND.
Commented out these hyperslab functions since they are not "turned on"
for Release 1.6:
H5Scombine_hyperslab
H5Scombine_select
H5Sselect_select
and the corresponding FORTRAN routines
Platforms tested:
Safari, IE 5
Purpose:
Link in additional Fortran90 functions.
Description:
Linked 68 new Fortran90 functions to the discussions of the corresponding
C functions. Made the corresponding Fortran index changes in the
function listings at the tops of the RM pages.
Fixed formatting and link typos in RM_H5P.html & fortran/h5p_FORTRAN.html.
Platforms tested:
Safari and IE 5
Purpose:
New feature: Fill value and storage space allocation changes
Description:
Modified the following functions:
H5Pset_fill_value H5Pget_fill_value
Added the following functions:
H5Pfill_value_defined
H5Pset_fill_time H5Pget_fill_time
H5Pset_alloc_time H5Pget_alloc_time
Platforms tested:
Safari, IE 5
Purpose:
New filter functionality
Rename section to reflect filters rather than strictly compression
Description:
"Compression Interface" --> "Filter and Compression Interface"
Renamed section as "Filter and Compression Interface".
Extended introductory paragraphs to BRIEFLY describe filter pipeline.
Edit H5Zregister to speak from point of view of filters rather than
compression only.
Add H5Zunregister.
Add H5Zfilter_avail.
Platforms tested:
Safari, IE 5
Purpose:
New feature -- Fill value and storage space allocation changes
Description:
Added H5Dget_space_status
Modified H5Dcreate and H5Dread to discuss
Also, copy and readability edits in H5Dcreate, H5Dread, and H5Dwrite
Platforms tested:
IE 6, Safari
Purpose:
Adding descriptions of new library features to the RM
Description:
H5Pset_fapl_log: Added new 'buf_size' parameter.
New 'flags' parameter replaced 'verbosity' parameter,
requiring new table describing 20 available flags.
H5Pset_filter: Added valid 'filter' parameter values.
Modified for Fletcher32 EDC filter.
H5Pget_filter: Added return value descriptions.
H5Pset_layout & H5Pget_layout: Modified for compact datasets.
Added the following new functions:
H5Pset_fletcher32
H5Pset_edc_check & H5Pget_edc_check
H5Pset_filter_callback
H5Pset_shuffle
Platforms tested:
Safari
IE 6
Purpose: Catching up with the C library
Description: Updated documentation files to include information on the following functions
h5iget_name_f
h5tis_variavle_str_f
h5zunregister_f
h5zfilter_avail_f
h5pset_shuffle_f
h5pset_fletcher32
h5pset_edc_check_f
h5pget_edc_check_f
h5dfill_f
Solution:
Platforms tested: arabica(C and F90), burrwhite (pgcc and pgf90), modi4 (F90 and parallel)
Misc. update:
Bug fix
Description:
"make distclean" is failing currently in the doc/html/ed_libs and
doc/html/ed_styles directories for lack of a 'Dependencies' file.
Solution:
Add it.
Platforms tested:
FreeBSD 4.7 (sleipnir)
Misc. update:
Purpose:
DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of
stylesheets and DW libraries.
Stylesheets -- for consistent format management.
DW libraries -- for managing common elements across documents.
Platforms tested:
IE 5 and 6
Netscape
Purpose:
Adding stylesheets to the HDF5 doc set (via DW libraries).
Description:
These HTML stylesheets are for consistently managing formatting issues.
The *Elect* stylesheets will be used in the distributed HTML doc set,
i.e., the electronic version; the *Print* stylesheets will be used to
generate printer-friendly versions.
Platforms tested:
IE 5 and 6
Netscape
Purpose:
Adapting the document set for use with DreamWeaver.
Description:
These are the DreamWeaver library files, which will be used to manage
common elements across documents: elements that are identical in many
places across the doc set and when they change, they change everywhere.
Testing:
IE 5 and 6
Netscape
Purpose:
Maintenance
Description:
* Added support for generic properties.
* Added support for time allocation properties.
* Added support for variable length datatypes (only datatypes based
on INTEGER, REAL and CHARACTER Fortran types are supported).
* added some missing functions
Solution:
I am checking in new Fortran APIs and their man pages to support
1.5 features listed above.
Not all APIs have tests yet. APIs were written in Fall 2002, and I am afraid
that I will loose the code or totally forget what I did if I wait longer. ;-)
Platforms tested:
arabica (fortran), eirene (fortran), modi4 (parallel, fortran)
Purpose:
To bring the H5Z_func_t definition from the old User's Guide
into the Reference Manual.
Description:
Added custom filter function H5Z_func_t definition to the
H5Zregister function description.
This definition will next be edited to bring it up-to-date.
Platforms tested:
IE 5
Purpose:
Bug fix
Description:
man pages for the following F90 functions were missing:
h5tget_super_f h5tarray_create_f h5tget_array_ndims_f
h5tget_array_dims_f
Solution:
Added missing man pages
Platforms tested:
IE
Purpose:
Adding new H5Fget_obj_* functions. (Development branch only)
Description:
Added H5Fget_obj_count.
Stubbed in H5Fget_obj_ids, but the entry is not filled in.
Reordered entries to group similar functions.
Platforms tested:
IE 5
Purpose:
Added missing fortran functions h5set(get)_buffer_f.
Also added docs and tests for them.
Solution:
Currently functions do not accept conversion and background buffers.
This corresponds to H5set(get)_buffer call with buffer pointers
set to NULL. If there is a demand, I can overload the functions
to have new parameters and go through all trouble creating functions
for all supported datatypes.
Platforms tested:
Solaris 2.7, Linux 2.2., IRIX64-6.5
Purpose:
Added new F90 APIs
Description:
I added new F90 APIs, tests, and documentation for the following
functions:
h5fget_obj_count_f h5pequal_f h5tget_member_index_f
h5fget_obj_ids_f h5pget_fclose_degree_f
h5pset_fclose_degree_f
Documentation for exisiting functions was missing:
h5freopen_f, h5fflush_f, h5fmount_f, h5unmount_f, h5fget_create_plist_f,
h5fget_access_plist_f.
Platforms tested:
Solaris 2.7, Linux 2.2 and IRIX64-6.5
Purpose:
Added new fortran functions
Description:
Source code, tests and documentation for h5glink2_f and h5gmove2_f
functions were added. I also added missing man page for h5glink_f
Platforms tested:
Solaris 2.7, IRIX64-6.5 and Liniux 2.2
Purpose:
Added missing fortran functions.
Description:
Four Library Fortran API functions have been added:
h5get_libversion_f, h5_check_version_f, h5garbage_collect_f and
h5dont_atexit_f. Only first two functions were tested.
Documentation file and RELEASE.txt were updated.
Platforms tested:
Solaris 2.7, IRIX64-6.5 and Linux 2.2
Purpose:
Add copyright and change "HDF5 Tutorial" link.
Description:
Added copyright statement and link.
Changed the "Tutorial" link to point to the copy on the HDF5 website.
Since the Tutorial is not maintained in CVS, the distributed
version of the Tutorial is being unlinked and removed from the
set of distributed files. It is hoped that we can begin
maintaining the Tutorial under CVS prior to Release 1.6 and
resume its distribution.
Platforms tested:
IE 5
Purpose:
Bugfix
Description:
Corrected H5Zregister description, syntax, and parameter descriptions.
There is one 'function' parameter, rather than the separate
'compression-function' and 'uncompression-function' parameters that
were previously listed.
Platforms tested:
IE 5
Purpose:
Clarification regarding sizes of some super block elements.
Description:
Added note to "HDF5 Super Block Layout" table that the last 5 items
are of the size specified in 'Size of Offsets'.
Platforms tested:
IE 5
Purpose:
Two new functions and a few copy-edits.
Description:
Added H5Pset/get_small_data_block_size.
Copy edits -- several typographic (spelling) corrections.
Platforms tested:
IE 5
Purpose:
Update h5dread/write_f parameters
Description:
fortran/h5d_FORTRAN.html
h5dread/write_f -- in the 'reference' versions, which yesterday's
revisions missed):
Added new overloading to dims parameter description.
Corrected prior dims type and noted that it is deprecated and
will be removed in 1.6.
fortran/h5a_FORTRAN.html
Updated "Last modified" tag to reflect yesterday's revisions.
Platforms tested:
IE 5
Purpose:
Bugfix -- Closes#702
Description:
Commented out references to and descriptions of unimplemented
H5S functions. Particularly in the UG document, Dataspaces.html.
H5Sopen H5Slock H5Ssubspace
H5Scommit H5Sselect_op H5Ssubspace_name
H5Sis_subspace H5Sselect_order H5Ssubspace_location
Added explanatory "Note to developers" in comments near top of
Dataspaces.html.
Platforms tested:
IE 5
Purpose:
Update description of h5dread/write_f and h5aread/write_f dims parameter.
Description:
h5dread/write_f, h5aread/write_f
Added new overloading to dims parameter description.
Noted that prior dims type is deprecated and will be removed in 1.6.
Platforms tested:
IE 5
