Commit Graph

26 Commits

Author SHA1 Message Date
Frank Baker
0795224bbb [svn-r2384] Updated "Last modified:" date. 2000-06-09 13:44:39 -05:00
Frank Baker
59934304f0 [svn-r2383] Datatypes.html
RM_H5T.html
	Updated descriptions of H5T_conv_t.
2000-06-09 13:42:57 -05:00
Frank Baker
833a8db230 [svn-r2381] Added line to each HTML doc file noting release number.
In many cases, also updated "Last modified:" date.
2000-06-09 13:02:29 -05:00
Frank Baker
8e8550af43 [svn-r2356] Navigational cross-linking fixes within the distributed HDF5 doc set
and from index.html to the HDF5 website.
2000-06-07 11:36:06 -05:00
Frank Baker
c4426337ff [svn-r2328] H5.user.html: Minor reformatting.
Removed old "Developer Docs" section to move to "HDF5 Tech Notes."
Datatypes.html:  Minor edits.
	Fixed confusing references to "simple datatypes."
Attributes.html
	H5Aiterate: Changed function type to herr_t.
2000-06-02 16:56:50 -05:00
Frank Baker
1dc7260d8a [svn-r1901] Update version to 'HDF5 Release 1.2.1' or 'HDF5 Release 1.2.x'. 1999-12-17 14:26:03 -05:00
Frank Baker
1be0e51101 [svn-r1896] RM_H5T.html
Datatypes.html
	H5Tget/set_fields:  Added spos parameter.  (RM_H5T.html only)
	H5Tconvert:  Added plist_id parameter.  (Both)
	    (Datatypes.html may still need explanatory text.)
1999-12-17 10:49:50 -05:00
Frank Baker
032537f13a [svn-r1876] Datatypes.html
Formatting fixes found in the process of creating PS/PDF version.
1999-12-14 14:01:34 -05:00
Frank Baker
044a84e972 [svn-r1775] HDF5 User's Guide files
Added Performance.html to TOC lists.
 	Made "data type" and "datatype" consistently one word.
1999-10-17 15:41:58 -05:00
Frank Baker
2eabae2d3a [svn-r1750] Datatypes.html (all VL datatypes work)
Added VL example code.
	H5Pset_vlen_mem_manage_type:  Removed.
	H5Pset_vlen_mem_manager:  More complete discussion of usage
	  of default and user-defined memory management functions.
RM_H5P.html
	H5Pset_vlen_mem_manager: rewrote usage description
	  for alloc and free paramaters and added summary.
	H5Pget_btree_ratios: corrected PURPOSE statement.
1999-10-14 15:48:14 -05:00
Frank Baker
6d81d3e643 [svn-r1676] Datatypes.html
Integrated DataypesEnum.html and VLdatatypes.html into this
		file to create a single Datatypes document for the UG.
	Changed to consistent use of 'datatype' (where we had both
		'datatype' and 'data type').
1999-09-27 20:56:55 -05:00
Frank Baker
3229952348 [svn-r1570]
RM_H5F.html
RM_H5S.html
RM_H5T.html
Dataspaces.html
Datatypes.html
	Corrected return type (nbool_t to htri_t) for the functions
	H5Fis_hdf5, H5Sis_simple, H5Sselect_valid, H5Tcommitted, and H5Tequal.

RM_H5S.html
	Corrected h5s_selopt_t to H5S_selopt_t (3 places).
	Corrected description of H5Sget_select_npoints.
1999-08-13 14:39:29 -05:00
Frank Baker
b872c241d3 [svn-r1539]
Datatypes.html
VLdatatypes.html (temporary doc file)
RM_H5T.html
RM_H5D.html
	Adding variable-length datatype information to the user docs.
        VLdatatypes.html is a temporary file; it will be removed once
	all of the information is incorporated into Datatypes.html
	and the RM.
1999-07-23 18:08:41 -05:00
Frank Baker
229cac82de [svn-r1528]
All HDF5 User's Guide files
	Integrated Palettes.html.
	Integrated MountingFiles.html.
	Cleaned up page footers.
	Made <title>---</title> entries somewhat more consistent.

Files.html
Errors.html
Datasets.html
	Fixed minor formatting errors.

Palettes.html
MountingFiles.html
	These new sections were added to the HDF5 User's Guide.

Environment.html
	Deleted duplicate text.
1999-07-22 15:58:29 -05:00
Frank Baker
0a8859d589 [svn-r1523]
Datatypes.html
   Changed references to 'handle' to read 'identifier'.

References.html
   Corrected reference to H5Ddereference to read H5Rdereference.
1999-07-21 15:45:37 -05:00
Frank Baker
a129c4d54e [svn-r1404]
H5.format.html
	Copy edits
	Beginning of revisions to bring the Specification up-to-date and
	    move it to present tense
	Couple of new intro paragraphs, designed largely to offer the
	    user a bit more context

H5.user.html
Datatypes.html
	Font correction and minor formatting changes.

H5.user.PrintGen.html
H5.user.PrintTpg.html
	New files to enable creating a searchable and printable version
	of the HDF5 User's Guide.  These files enable the creation of a
	PDF file containing the entire document.  H5.user.PrintGen.html
	controls the print job; H5.user.PrintTpg.html is the title page
	for the PDF volume.
1999-07-01 21:54:33 -05:00
Robb Matzke
b98fcbf592 [svn-r1306] Changes since 19990602
----------------------

./doc/html/Datatypes.html
./test/dtypes.c
	Added documentation and tests for opaque types.

./tools/h5ls.c
	Added a `-x' or `--hexdump' argument which is not fully
	implemented (because I want to synchronize h5tools.c first)
	but which will eventually print raw data in hexadecimal format
	without any translation from disk. This would be useful for
	debugging references and VL types.

./tools/h5tools.c
	Added support for references (not quite finished yet, but
	compiles -- I wanted to sync up this file before Patrick and I
	got too far apart...)


./src/H5R.c
	Checked for error return value from H5R_get_object_type()

./src/H5A.c
./src/H5D.c
	Changed error return values from NULL to FAIL

./test/Makefile.in
./test/trefer.c
	Creates trefer1.h5 and trefer2.h5 so that the second test
	doesn't clobber the first file since the files might be useful
	for debugging.
1999-06-07 10:05:02 -05:00
Frank Baker
a3d84da7df [svn-r1244] Datatypes.html
DatatypesEnum.html
EnumMap.gif
	Added enumeration datatypes -- First pass, only minimal editing.
	Intro paragraph in Datatypes.html; details in DatatypesEnum.html.
	EnumMap.gif is a figure for DatatypesEnum.html.

Tools.html
	Added new h5toh4 supported object and data type.

H5.intro.html
	Corrected transposed "start coordinates" in Example 1.
1999-05-03 16:54:10 -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
Robb Matzke
09aaf83332 [svn-r971] Changes since 19981214
----------------------

./INSTALL
	Added warning that enabling debugging code can adversely
	affect performance even when the debugging isn't turned on at
	run-time. Performance testing shows that under certain
	circumstances (like data type conversions of compound types)
	the H5_timer functions, although only a few lines each,
	contribute a fairly large percent to the execution time.

./src/H5T.c
./src/H5Tpkg.h
./src/H5Tpublic.h
	Improved the H5Tunregister() function to make unregistering
	more flexible.  It takes the same arguments as H5Tregister()
	but also accepts wild cards.  All conversion functions that
	match the H5Tunregister() search criteria are removed from the
	global type conversion table.

	The H5Tregister_hard() and H5Tregister_soft() were combined
	into a single function called H5Tregister() which is the
	counterpart to H5Tunregister(). A new `persistence' argument
	was added to differentiate between the two types of conversion
	functions.

	The application is allowed to register a hard conversion
	function for the no-op conversion path although the library
	isn't obligated to call it (it usually does). This is mostly
	for completeness, but the application might use it to help
	determine if the raw data pipeline was able to use the
	optimized path for the case when no type conversion is
	necessary. The library doesn't allow this path to be
	unregistered although the application can redefine it as often
	as it likes.

	Fixed the type conversion tables in preparation for MT-safety
	and to fix previosly-known design bugs wrt. unregistering
	conversion functions or changing the C function associated
	with a conversion path. The MT-safety stuff is documented in a
	separate white paper.

	Increased the conversion function debugging name from 9
	characters to 31 characters so the output can be more
	descriptive.

	Moved conversion path statistics from the H5T_cdata_t member
	into the conversion path itself.  This makes H5T_cdata_t
	contain only application-visible data structures.

./src/H5A.c
./src/H5D.c
./src/H5Ofill.c
./src/H5P.c
./src/H5T.c
	Improved the way type conversion functions are called so the
	caller doesn't have to check for data type debugging and
	increment type conversion timers and statistics.

	Changed check for no-op conversion since it is now
	application-definable and there may even be more than one
	definition at a time in a multi-threaded application (one
	thread might be using the no-op conversion path when some
	other thread changes its definition -- the first thread still
	sees the original defintion until it's done with the
	operation).

./doc/html/Datatypes.html
	Updated the user guide to reflect the changes to data type
	conversion registration functions.

./bin/trace
./src/H5.c
	Added tracing support for the new H5T_pers_t data type.

./test/dtypes.c
	Added printf to display alignment value if non-aligned data
	types are being tested.

./test/h5test.c
	Modified the H5Tunregister() calls to use the new
	arguments. All 94 of those calls can be replaced by a single
	call to the new H5Tunregister() function.

./src/H5.c
	Added HAVE_GETTIMEOFDAY around an auto variable and
	initialized the elapsed time to zero when gettimeofday() is
	not available.

./src/H5F.c
./src/H5Fprivate.h
./src/H5P.c
	Added an H5*_init() functions which do the same thing as
	H5*_init_interface() but can be called from other packages and
	don't do anything if the interface is already initialized.
	This fixes a couple memory leaks in applications that
	repeatedly close and open the library with H5close().

./src/H5Tconv.c
	Optimized some data alignment code in the hardware conversion
	functions.

	Hardware conversions accumulate statistics about source and
	destination data alignment and print that information when the
	conversion function is unregistered (usually when the
	application exits) if data type debugging is compiled into the
	library and enabled at run-time.

	The conversion caching was cleaned up for the compound data
	type conversion function. It now caches conversion paths in a
	manner that will be MT-safe and is much simpler than the old
	method. Also cleaned up some array index maps.

./src/H5detect.c
	Fixd mispelling of alingemnt.

./src/H5private.h
	Changed `TRUE' to `1' in assignment to interface_initialize_g
	in FUNC_ENTER macro definition.

./tools/testh5dump.sh
	Completely rewritten to make it shorter, better documented,
	and conforming to most of the other test outputs.

	The comparison of the actual output with the expected output
	is insensitive to differences in white space.  The test now
	passes for the first time on Linux where the output width
	wasn't as expected but the output was otherwise correct.

./tools/testfiles/tall-1.ddl
./tools/testfiles/tall-2.ddl
./tools/testfiles/tall-3.ddl
./tools/testfiles/tattr-1.ddl
./tools/testfiles/tattr-2.ddl
./tools/testfiles/tattr-3.ddl
./tools/testfiles/tattr-4.ddl
./tools/testfiles/tcomp-1.ddl
./tools/testfiles/tcomp-2.ddl
./tools/testfiles/tcomp-3.ddl
./tools/testfiles/tcomp-4.ddl
./tools/testfiles/tdset-1.ddl
./tools/testfiles/tdset-2.ddl
./tools/testfiles/tdset-3.ddl
./tools/testfiles/tdset-4.ddl
./tools/testfiles/tgroup-1.ddl
./tools/testfiles/tgroup-2.ddl
./tools/testfiles/tgroup-3.ddl
./tools/testfiles/tlink-1.ddl
./tools/testfiles/tlink-2.ddl
./tools/testfiles/tlink-3.ddl
./tools/testfiles/tlink-4.ddl
./tools/testfiles/tlink-5.ddl
./tools/testfiles/tslink-1.ddl
./tools/testfiles/tslink-2.ddl
	Changed `../h5dump' to just `h5dump'.

./config/alpha-dec-osf4.0
	Added more warning and optimization switches to the native
	compiler.
1998-12-17 14:35:20 -05:00
Robb Matzke
ffcbc32d66 [svn-r952] Changes since 19981125
----------------------

./doc/html/Datatypes.html
./src/H5.c
./src/H5T.c
./src/H5Tconv.c
./src/H5Tpkg.h
./src/H5Tpublic.h
./src/H5detect.c
./test/chunk.c
./test/dtypes.c
./test/h5test.c
./test/mtime.c
./test/tattr.c
./test/th5s.c
./tools/h5dump.c
./tools/h5dumputil.c
./tools/h5import.c
./tools/h5ls.c
./tools/h5toh4.c
./tools/h5tools.c
	Renamed the old H5T_NATIVE_CHAR type to H5T_NATIVE_SCHAR to
	denote that it is always signed.

	Added a new H5T_NATIVE_CHAR type which has the same range,
	representation, and behavior as either H5T_NATIVE_SCHAR or
	H5T_NATIVE_UCHAR depending on the compiler and its
	command-line switches for the application source file which
	references H5T_NATIVE_CHAR. If source files are compiled with
	different switches then each source file will resolve
	H5T_NATIVE_CHAR appropriately so it matches the C type `char'
	in that source file.

	NOTE: THERE ARE OTHER DOCUMENTATION FILES THAT I DIDN'T CHANGE
	BECAUSE I CAN'T MODIFY THE SOURCE.

./test/extend.c
	Swapped two lines to prevent diagnostic messages from messing
	up the formatted output.
1998-11-25 12:21:21 -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
dd99ecc1bc [svn-r680] H5.user.html
A little editorial cleanup.
   Added link to Ragged.html, Ragged Arrays.
   Added link to Environment.html, Environmental Variables and
	Configuration Parameters.
   Added link to Copyright.html.

Ragged.html
   Added "Use at your own risk" notice.

Environment.html
   New file for environmental variables and configuration parameters.

Datatypes.html
   Added the following datatypes:
	H5T_NATIVE_HSIZE
	H5T_NATIVE_HSSIZE
	H5T_NATIVE_HERR
	H5T_NATIVE_HBOOL
   Section 8, "Data Conversions"
	Added named link tag to catch hyperlink from RM.
	Revised "Note:" to emphasize limited inate data-conversion capability.

Copyright.html
   New file.
   Copyright statement, linked into User's Guide and Reference Manual.

Glossary.html
   Unlinked for Beta.

General
   Changed email link at bottom of "user guide level documents"
	(as contrasted with "developer guide level documents"
	listed on the lower half of the User's Guide front page)
	to HDF Help Desk, hdfhelp@ncsa.uiuc.edu.
   Changed the following function names:
	From:                       To:
	H5version                   H5get_libversion
	H5vers_check                H5check_version
	H5Anum_attrs                H5Aget_num_attrs
	H5Fget_create_template()    H5Fget_create_plist()
	H5Fget_access_template()    H5Fget_access_plist()
	H5Gstat                     H5Gget_stat
	H5Sextent_npoints           H5Sget_simple_extent_npoints
	H5Sextent_ndims             H5Sget_simple_extent_ndims
	H5Sextent_dims              H5Sget_simple_extent_dims
	H5Sget_class                H5Sget_simple_extent_type
	H5Sselect_npoints           H5Sget_select_npoints
1998-09-09 17:48:37 -05:00
Robb Matzke
b5e2752ad6 [svn-r673] Changes since 19980908
----------------------

./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.
1998-09-08 14:15:44 -05:00
Robb Matzke
9754e9373b [svn-r584] Changes since 19980806
----------------------

./doc/html/Datatypes.html
./doc/html/H5.format.html
./src/H5.c
./src/H5Odtype.c
./src/H5T.c
./src/H5Tconv.c
./src/H5Tpkg.h
./src/H5Tpublic.h
./test/dtypes.c
	Changed the values of the H5T_str_t type in order to make a
	distinction between C's null terminated strings and strings
	which are not null terminated.

	The string character set and padding method are saved to the
	hdf5 file instead of using defaults.

	Added conversion function from one fixed-length string type
	to another.

./test/chunk.c
	Fixed to work with new filter API
1998-08-10 13:15:14 -05:00
Quincey Koziol
bd1e676c52 [svn-r467] Restructuring documentation. 1998-07-08 09:54:54 -05:00