Commit Graph

14 Commits

Author SHA1 Message Date
Frank Baker
243c60e8b5 [svn-r3105]
Purpose:
	Thoughout doc set (UG, RM, Intro, FormatSpec, and index/TOC pages):
	    Added/updated "Describes HDF5 Release ..." entry.
	    In many cases, verified/updated "Last modified ..." entry.
Platforms tested:
	IE 5
2000-12-08 17:12:36 -05:00
Frank Baker
cfe6744d58 [svn-r2881] Purpose:
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.
2000-11-13 12:56:47 -05:00
Frank Baker
b527d73dda [svn-r2873]
Purpose:
    Adding all functions new to Release 1.4.
Solution:
    Adding first cut of all new API functions.
    H5Dvlen_get_buf_size
    H5Epush
    H5Pset_fapl_family       H5Pget_fapl_family
    H5Pset_fapl_mpio         H5Pget_fapl_mpio
    H5Pset_dxpl_mpio         H5Pget_dxpl_mpio
    H5Pset_fapl_multi        H5Pget_fapl_multi
    H5Pset_dxpl_multi        H5Pget_dxpl_multi
    H5Pset_fapl_split        H5Pset_fapl_sec2          H5Pset_fapl_stdio
    H5Pset_fapl_stream       H5Pget_fapl_stream
    H5Pset_fapl_log
    H5Pset_driver            H5Pget_driver             H5Pget_driver_info
    H5Pset_meta_block_size   H5Pget_meta_block_size
    H5Pset_sieve_buf_size    H5Pget_sieve_buf_size
    H5Pset_fapl_dpss
    H5Pset_fapl_gass         H5Pget_fapl_gass
    H5Pset_fapl_srb          H5Pget_fapl_srb
    H5Tarray_create          H5Tget_array_ndims        H5Tget_array_dims
Platforms tested:
    IE 5.
2000-11-13 11:35:49 -05:00
Frank Baker
315e9c17f4 [svn-r2435] RM_H5[EIPRT].html
RM_H5Front.html
	Added new Fortran90 functions and links.  Related edits.
	Added "Describes HDF5 Release..." line in page footers.
	Minor editorial corrections.
2000-07-17 14:14:30 -05:00
Frank Baker
56289a2c10 [svn-r2427] RM_H5T.html
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.
2000-07-06 11:31:40 -05:00
Frank Baker
5228ba6c71 [svn-r2090] RM_H5D.html
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.
2000-04-07 14:38:42 -05:00
Frank Baker
4d57b9df22 [svn-r2006] RM_H5D.html
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'.
2000-03-08 17:14:46 -05:00
Frank Baker
4d18fe3563 [svn-r1897] RM_H5T.html H5Tset/get_fields: Added spos parameter.
H5Tconvert:  Added plist_id parameter.
1999-12-17 10:54:15 -05:00
Frank Baker
658fdbfb98 [svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree.
(except Datatypes.html, H5.format.html, ddl.html)
	This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-13 15:39:48 -05:00
Frank Baker
d70b72d630 [svn-r1425]
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.
1999-07-06 11:56:15 -05:00
Frank Baker
82fb21b613 [svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet
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.
1998-12-21 17:52:56 -05:00
Frank Baker
cd3b105997 [svn-r830] ======
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.
1998-10-29 17:13:17 -05:00
Frank Baker
3672cb4c1c [svn-r693] Update for beta release. Complete CVS log messages can be found with
the versions of these files that are maintained in hdf5/doc/src/.
1998-09-11 11:00:43 -05:00
Frank Baker
c8e75d27b0 [svn-r503] HDF5 Reference Manual
Updated for Alpha2.
1998-07-14 23:51:50 -05:00