Purpose:
Expanded descriptions and minor copy edits.
Description:
H5Fcreate, H5Fopen, H5Fclose
Changes stemming from Albert's H5Fxxx proposal
Added IN/OUT designations to parameters.
Minor formatting and copy edits
[Sorry, but "no space left on device" error prevents deletion
of extra blank lines!]
Platforms tested:
IE 5
Bugfixes and editing.
Description:
RM_H5T.html
H5Tget_class -- Added H5T_ARRAY to list of valid datatype class IDs.
Closes bug #611.
-- Minor formatting issue in same command.
RM_H5F.html
H5Fflush -- Added "Note:" re H5 vs OS buffers.
H5Fclose -- Corrected mentions of H5close to read H5Fclose.
RM_H5P.html
Removed () from several H5* function names in running text.
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:
Clarification of H5Fclose
Description:
RM_H5F.html / H5Fclose: Added note that all data is flushed to file.
Platforms tested:
Tested with IE 5.
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.
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.
in parameters section and removed reference to H5Fpublic.h.
RM_H5D.html H5Dvlen_reclaim: Inserted missing punctuation.
H5Dcreate: Added paragraph explaining that 'name' must be unique.
RM_H5S.html
Dataspaces.html
H5Sselect_hyperslab
H5Sselect_elements
Add H5S_SELECT_OR operator.
Converted operator list to a table.
H5Sextent_copy
Corrected source and destination descriptions. (RM_H5S.html only)
H5Screate
Removed unused H5S_NONE dataspace type.
H5Sset_extent_none
Corrected reset class type to H5S_NO_CLASS (previously said H5S_NONE).
RM_H5G.html
H5Gget_linkval
Corrected descriptions of 'loc_id', 'name', and 'value'.
Corrected "Purpose".
Emphasized need to call H5Gget_objinfo first.
H5Gset_comment
H5Gget_comment
Corrected description of 'loc_id'.
H5Gget_objinfo
Corrected description of 'loc_id'.
Added H5G_TYPE to list of valid values of 'type'.
RM_H5F.html
ExternalFiles.html
H5Fmount
H5Funmount
Corrected description of 'loc_id'.
Changed function descriptions in ExternalFiles.html to correspond to RM.
RM_H5T.html
Moved H5Tget_class and H5Tget_size to "General Datatype Operations" in top index.
been checked into "HDF5 Development" branch.
General
=======
Various "copy edit" types of repairs.
Revisions to document cross-linking.
Added structural links tying all docs together (banners
at top and bottom of documents, similar to Reference Manual
banners of the Beta release).
Set background color to white in all documents.
NCSAfooterlogo.gif
hdf2.jpg
New image files to make the documents more self-contained
(i.e., to prevent loading images from NCSA and HDF home servers).
index.html
Redesigned to isolate links external to the installation
in a single location.
Intro to HDF5
=============
H5.intro.html
Fixed banner linking Intro to other docs.
Set all URLs to be relative within the distribution; nothing
points back to the HDF server.
Updates to "Limits of the Current Release" and "Changes in
the Current Release."
HDF5 User's Guide
=================
Changed several User Guide section titles such that all
sections that are primarily about a particular interface
are now titled in the format "The xxxxx Interface (H5x)".
H5.user.html
Commented out links to developer docs since they are marked
in MANIFEST as not being for distribution in the release.
Removed 2nd and 3rd indices from page.
Changed "freeform" lists of sections (TOCs) to aligned tables.
Datatypes.html
Removed the sentence "I'm deferring definition until later
since they're probably not as important as the other data
types." from Section 3.3, "Properties of Date and Time
Atomic Types."
Added info regarding 'char' versus 'string' datatypes. Added
as Section 3.7, "Character and String Datatype Issues."
References.html
Commented out substantial material (at end of document) from
References planning document that is not appropriate for
the User Guide but that is worth keeping around.
Groups.html
Final edits from elimination of "current working group."
HDF5 Reference Manual
=====================
Removed "Draft" from the <title>__</title> lines.
RM_H5Front.html
Removed 2nd and 3rd indices from page.
Changed "freeform" lists of sections (TOCs) to aligned tables.
RM_H5F.html
RM_H5P.html
Add file mounting information.
Intro
======
H5.intro.html
Major rewrite to Groups section. New Example 7 (groups).
Added TOC and requisite links.
Numbered sections.
Labelled figures and centered those that were not.
Fixed table formatting.
===========
User Guide
===========
H5.user.html
Linked in Chunking.html.
Linked in References.html.
Linked in DDL.html.
Chunking.html
Minor edits.
DDL.html
References.html
New documents.
Datatypes.html
Added "R Reference" to base name description and
"H5T_STD_ROBJ -- Reference to an entire object
in a file" to list of datatype names.
Files.html
H5Fflush
Added scope parameter.
Groups.html
Removed references to "current working group."
Removed H5Gpush, H5Gpop, and H5Gset functions.
Removed note that H5Glink and H5Gunlink were not implemented.
=================
Reference Manual
=================
RM_*.html and Tools.html
Updated Reference Manual internal cross-linking (the link
banner at the top and bottom of each page).
Changed
Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
to read
Returns a non-negative value if successful;
otherwise returns a negative value.
and several derived changes where circumstances differred
only slightly.
Minor copy edits throughout.
RM_H5.html
Corrected H5open "Purpose" statement.
RM_H5A.html
Changed H5Aget_name return type to hssize_t.
RM_H5F.html
H5Fflush
Added scope parameter.
Added H5Freopen.
RM_H5Front.html
Reordered listing of interfaces to alphabetical order (H5,
H5A, H5D, ...)
Added H5I, H5R, and H5RA.
RM_H5G.html
H5Gopen
Edited "Description."
H5Gget_objinfo
Added named datatype to list of valid values for loc_id.
RM_H5I.html Identifier Interface
New section.
RM_H5P.html
Added H5Pset_fill_value and H5Pget_fill_value.
Several minor copy edits.
RM_H5R.html Reference Interface
New section.
H5RA.html
Essentially a new section. It was in the tree previously,
but it did not actually have content.
RM_H5S.html
Changed H5Sget_select_npoints return type to hssize_t.
Tools.html
Updated h5dump documentation.
Changed H5Sget_space_type to H5Sget_simple_extent_type.
Changed H5Sget_simple_extent_type FAIL return value to
H5S_NO_CLASS.
RM_H5F.html
H5Fflush. Corrected function name in sytax line, which
had read H5Fis_hdf.
RM_H5G.html
Removed discussion of "current working group" and associated
information from the introductory discussion.
H5Gset, H5Gpush, H5Gpop
Removed these functions.
H5Gunlink, H5Gmove
Removed the "not yet implemented" notations from
these functions.
----------------------
./COPYING
Reformatted as text instead of C. Removed zlib crew from the
list of contributors since no zlib code is actually in the
hdf5 library.
./INSTALL
./INSTALL.ascired
./MANIFEST
Minor updates for Beta release including version number
change.
./INSTALL_MAINT
Added information about making a release.
./RELEASE
Updated function list based on public header files.
./bin/checkposix
Got rid of complaints about some obvious things.
./doc/html/H5.api.html
./doc/html/RM_H5F.html
./src/H5F.c
./src/H5Fpublic.h
./test/tfile.c
Changed H5Fget_create_template() and H5Fget_access_template()
to H5Fget_create_plist() and H5Fget_access_plist() since that
conforms better to lots of other names.
./doc/html/Datatypes.html
./doc/html/ExternalFiles.html
./doc/html/Files.html
./doc/html/H5.api.html
./doc/html/H5.sample_code.html
./doc/html/RM_H5F.html
./doc/html/RM_H5Front.html
Changed `template' to `property list', etc.
./doc/html/Ragged.html [NEW]
Documentation for ragged arrays.
./src/H5Iprivate.h
./src/H5Ipublic.h
./src/H5I.c
Changed the scope of some symbols to be more local.
./src/H5.c
./src/H5AC.c
./src/H5D.c
./src/H5E.c
./src/H5F.c
./src/H5Ffamily.c
./src/H5Fistore.c
./src/H5Flow.c
./src/H5Fsec2.c
./src/H5Fsplit.c
./src/H5Fstdio.c
./src/H5G.c
./src/H5Gnode.c
./src/H5HG.c
./src/H5I.c
./src/H5O.c
./src/H5Ocomp.c
./src/H5Odtype.c
./src/H5Oefl.c
./src/H5Omtime.c
./src/H5Oname.c
./src/H5P.c
./src/H5S.c
./src/H5Shyper.c
./src/H5Tbit.c
./src/H5Tconv.c
./src/H5V.c
./src/H5Z.c
./src/H5private.h
Fixed some violations of our naming scheme by adding HD to the
beginning of all Posix functions.
