| Commit message (Collapse) | Author | Age | Files | Lines |
|
|
|
|
|
|
|
|
| |
Description:
All HDF5 user documentation has been moved to a separate hdf5doc/
repository, managed under Subversion.
With this 'cvs commit', all files are stripped from hdf5/doc/.
THIS CHANGE IS APPLIED ONLY TO THE HDF5 DEVELOPMENT BRANCH,
post Release 1.6.x; it is not applied to the release branches.
|
|
|
|
|
|
|
| |
Purpose:
Added links to HDF5 High-Level API reference pages.
Platforms tested:
Firefox
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Bug Fix/Code Cleanup/Doc Cleanup/Optimization/Branch Sync :-)
Description:
Generally speaking, this is the "signed->unsigned" change to selections.
However, in the process of merging code back, things got stickier and stickier
until I ended up doing a big "sync the two branches up" operation. So... I
brought back all the "infrastructure" fixes from the development branch to the
release branch (which I think were actually making some improvement in
performance) as well as fixed several bugs which had been fixed in one branch,
but not the other.
I've also tagged the repository before making this checkin with the label
"before_signed_unsigned_changes".
Platforms tested:
FreeBSD 4.10 (sleipnir) w/parallel & fphdf5
FreeBSD 4.10 (sleipnir) w/threadsafe
FreeBSD 4.10 (sleipnir) w/backward compatibility
Solaris 2.7 (arabica) w/"purify options"
Solaris 2.8 (sol) w/FORTRAN & C++
AIX 5.x (copper) w/parallel & FORTRAN
IRIX64 6.5 (modi4) w/FORTRAN
Linux 2.4 (heping) w/FORTRAN & C++
Misc. update:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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:
Updated footers to "Describes HDF5 Release 1.7, the unreleased
development branch; working toward HDF5 Release 1.8.0"
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:
Integrate Fortran90 interfaces into C RM.
Solution:
Remove "Non-C APIs" sections.
Add "Fortran90 Interfaces" sections with F90 descriptions.
Platforms tested:
IE 5, Safari
|
|
|
|
|
|
|
|
|
| |
Purpose:
Aphabetic sort of RM function entries
Minor formatting
Platforms tested:
IE 5, Safari
|
|
|
|
|
|
|
|
|
|
|
|
| |
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:
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:
H5set_free_list_limits review feedback.
Link corresponding F90 function.
Description:
Added explanations of regular, array, and block free lists.
Copy edits. (both in response to review comments)
Linked in corresponding F90 function.
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:
Add new function.
Description:
Added H5set_free_list_limits.
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:
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
|
|
|
|
|
|
|
|
| |
Bringing 'last minute' release branch edits into development branch.
Description:
Updated H5check_version per recent expansion of the source comments.
Platforms tested:
IE 5
|
|
|
|
|
|
|
|
| |
Purpose:
Update "Describes HDF5 Release..." footer from R1.4 to
"Release 1.5, Unreleased Development Branch"
Platforms tested:
IE 5
|
|
|
|
|
|
|
|
| |
Purpose:
Update "Describes HDF5 Release..." footer from R1.4 to
"Release 1.5, Unreleased Development Branch"
Platforms tested:
IE 5
|
|
|
|
|
| |
Purpose:
Importing RM changes from 1.4 release branch into development branch (1.5)
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Purpose:
Marking files for "Release 1.4, February 2001."
Description:
Across doc files
Updating "Describes HDF5 Release..." entry to "Describes
HDF5 Release 1.4, February 2001."
Copyright.html: Added 2001 to years copyrighted.
index.html: Changed header to Release 1.4 (from 1.4 Beta)
Platforms tested:
IE 5
|
|
|
|
|
|
|
| |
Purpose, Description, and Solution:
Removed cross-links to Ragged Array doc files (above).
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:
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
|
|
|
|
| |
Added new function H5garbage_collect.
|
|
|
|
|
|
| |
RM_H5A.html H5Acreate: Restructured and expanded the Description section,
with particular attention to the fact that the attribute name
specified in H5Acreate must be unique.
|
|
|
|
|
| |
(except Datatypes.html, H5.format.html, ddl.html)
This version of HDF5 Ref Manual includes FORTRAN API references.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
|
|
|
| |
the versions of these files that are maintained in hdf5/doc/src/.
|
|
Updated for Alpha2.
|