Commit Graph

119 Commits

Author SHA1 Message Date
Frank Baker
ebd8bee9d7 [svn-r1773] H5.intro.html
Added "Working with referecences to objects" and "Working with
	  references to dataset regions" from Tutorial.
	Revised "Limitations of Current Release," "Changes in Current
	  Release," and some of the introductory paragraphs (:.
	Other minor edits and formatting fixes.
1999-10-17 15:34:01 -05:00
Frank Baker
bcf445038d [svn-r1772] Performance.html
New UG chapter.  Chunking pointer; brief Pablo discussion and pointer.
1999-10-17 15:29:44 -05:00
Albert Cheng
e20b3e4d2b [svn-r1756] Should not be added because it is derived from Makefile.in. 1999-10-15 10:49:15 -05:00
Frank Baker
60ded69d6c [svn-r1752] RM_H5T.html
H5Tenum_valueof: corrected PURPOSE statement.
1999-10-14 16:17:40 -05:00
Frank Baker
65e484b19e [svn-r1751] H5.format.html
MANY technical changes, perhaps hundreds, based on developer input.
	Deleted Complex Dataspace and minimized Free-sapce Index sections.
	Many copy edits and formatting fixes.
	Consistent title: HDF5 File Format Specification.
FF-IH_FileGroup.gif
	Revised drawing for HDF5 File Format Specification.
1999-10-14 16:13:00 -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
cba03198d1 [svn-r1747] Copied doc/html/Copyright.html into doc/html/Tutor/Copyright.html.
(The tutorial has a separate copy of the copyright notice so that it can
stand alone without the rest of the documentation tree.  This change
synchronizes the tutorial's copy with the rest of the documentation's
notice and with the code's copyright notice.)
1999-10-13 14:13:44 -05:00
Frank Baker
af71874ae0 [svn-r1746] Modified format to be consistent with rest of docs.
Revised "All publications and advertising materials..." requirement.
Added 1999 to copyright dates.
1999-10-13 14:03:02 -05:00
Frank Baker
fb1c2856c9 [svn-r1737] HDF5 Tutorial: First version of Tutorial to be checked in for distribution. 1999-10-08 18:03:26 -05:00
Frank Baker
3c2fc7a967 [svn-r1736] HDF5 Tutorial: First version of Tutorial to be checked in for distribution. 1999-10-08 18:03:05 -05:00
Frank Baker
c2306a366b [svn-r1721] RM_H5F.html
H5Funmount: Corrected description of second argument.
	  Clarified descriptions of loc_id and name.
	H5Gget_objinfo: Corrected datatype within H5G_stat_t struct.
	H5Fopen, H5Fcreate:  Corrected lists of allowable flags.
	  Corrected/expanded access_id and create_id descriptions.
	One simple copy edit.
1999-10-04 16:56:37 -05:00
Frank Baker
2c3783004c [svn-r1720] RM_H5T.html
H5Tget_nmembers: Corrected return type.
	H5Tinsert_array: Explained that perm parameter is not yet
		implemented; value should currently be set to NULL.
	  Specified limits on value of ndims.
	  Slightly expanded description of offset.
1999-10-04 16:55:31 -05:00
Frank Baker
636ab41cf0 [svn-r1719] RM_H5A.html
H5Aread: Corrected description of buf.
RM_H5P.html
	H5Pset_buffer: Expanded description of buffer size requirements.
	  Minor copy edits.
RM_H5S.html
	H5Sselect_elements, H5Sselect_hyperslab: Corrected op return type.
1999-10-04 16:54:22 -05:00
Frank Baker
538b76ea64 [svn-r1718] RM_H5.html
H5check_version: Deleted extraneous entry from PARAMETERS.
	  Added description of ABORT behavior when version
		numbers do not match.
	  Corrected parameter notation in PARAMETERS.
	H5check_version, H5get_libversion: Added IN/OUT to PARAMS.
1999-10-04 16:52:07 -05:00
Albert Cheng
a65d75525f [svn-r1715] Moved INSTALL_MAINT to doc/html/Lib_Maint.html.
Did a quick change to the file to make it an html file.
1999-10-03 01:22:24 -05:00
Albert Cheng
28415a8e06 [svn-r1713] Added the target to do install-doc in doc and its sub-directories.
For now, the Makefile in doc "translates" targets "install" and
"uninstall" to "install-doc" and "uninstall-doc" for its sub-directories.
1999-10-02 12:46:55 -05:00
Frank Baker
e6c1d392e3 [svn-r1678] Tools.html
Palettes.html
	Various copy-edits and cleaned up HTML.
Caching.html
	Edited section headers and added an <h1> header.
Errors.html
	Added section title "Error Handling Operations."
1999-09-27 21:03:05 -05:00
Frank Baker
7f885e42ac [svn-r1677] RM_H5P.html
Added 'Name' to H5Pget_core.
RM_H5D.html
	Added 'Purpose' to H5Dclose.
1999-09-27 20:58:26 -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
8210433773 [svn-r1675] DataypesEnum.html
VLdatatypes.html
	Removed these files; material has been merged into Datatypes.html.
1999-09-27 20:54:53 -05:00
Frank Baker
1c8a7fbd04 [svn-r1674] Dataspaces.html
RM_H5S.html
	Commented out H5Sextent_class.  It's still in the plan but not
	yet implemented.
RM_H5S.html
	Removed H5Sselect_name from list of functions that are not yet
		implemented but are described in the UG.
	Updated return value descriptions for H5Sis_simple
		and H5Sselect_valid to correspond to the earlier
		hbool_t -> htri_t change.
1999-09-27 20:51:56 -05:00
Frank Baker
ab1a73dd3a [svn-r1673] RM_H5T.html
Added H5Tget_member_offset.
	Corrected H5Tinsert description to read that an element of a
		compound datatype can itself be a compound datatype.
	Font correction.
RM_H5F.html
RM_H5T.html
	Updated return value descriptions for H5Fis_hdf5, H5Tcommitted,
	and H5Tequal to correspond to the earlier hbool_t -> htri_t change.
1999-09-27 20:48:44 -05:00
Frank Baker
e8ea992779 [svn-r1601] RM_H5T.htm
Corrected return types for H5Tenum_valueof and H5Tenum_nameof.
1999-08-25 17:36:42 -05:00
Frank Baker
2addc89f28 [svn-r1600]
RM_H5T.html
	Deleted H5Tregister_hard and H5Tregister_soft.
	Added H5Tregister.
	In H5Tunregister, removed duplicate description of conversion
		function pointer type declaration, referring reader to
		H5Tregister.
	Added H5Tenum_create, H5Tenum_insert, H5Tenum_nameof, H5Tenum_valueof,
		H5Tget_member_value, H5Tgset/get_tag, and H5Tget_super.
	Restructured the linked list of functions at the top of the page to
		accommodate the new entries.
RM_H5Front.html
	Since these are the last of the missing functions, removed the
	list of functions missing from the RM.
1999-08-25 17:18:12 -05:00
Frank Baker
80d964e6cf [svn-r1588] RM_H5S.html
Edited H5Sget_select bounds entry.
1999-08-24 15:25:18 -05:00
Frank Baker
48b014bc9a [svn-r1587]
RM_H5S.html
	Added H5Sget_select_hyper_nblocks, H5Sget_select_hyper_blocklist,
	H5Sget_select_elem_npoints, H5Sget_select_elem_pointlist, and
        H5Sget_select_bounds.
RM_H5Front.html
	As functions were added to the Reference Manual (above), they were
	removed from "functions missing in the RM" list in this document.
1999-08-24 15:14:18 -05:00
Frank Baker
8cffd507bf [svn-r1584] RM_H5D.html
Added H5DGet_storage_size and H5Diterate.
RM_H5F.html
	Rearranged TOC.
RM_H5P.html
	Added H5Pset/get_hyper_cache, H5Pset/get_btree_ratios, H5Pset/get_gc_references,
	and H5Pget_vlen_mem_manager.
RM_H5R.html
	Added H5Rget_object_type.
RM_H5Front.html
	As functions were added to the Reference Manual (above), they were
	removed from "functions missing in the RM" list in this document.
1999-08-23 15:31:25 -05:00
Frank Baker
e7c0ca229f [svn-r1579]
H5.format.html
	Expanded introduction.
	New HDF5 Group and HDF5 Object drawings.
	Beginnings of a general edit.

FF-IH_FileGroup.gif
FF-IH_FileObject.gif
	New drawings for Format Spec (H5.format.html).

Glossary.html
	Have begun adding terms, though as yet without definitions.
1999-08-19 15:43:51 -05:00
Frank Baker
8d2f82f859 [svn-r1578]
Attributes.html
RM_H5A.html
	Corrected H5Aget_name return type.
	(Each file had a different return type; both were wrong!)
1999-08-19 15:27:21 -05:00
Frank Baker
91e75701b4 [svn-r1571]
RM_H5Front.html
	Added list of functions that are not yet documented in the
	Release 1.2 Beta Reference manual.
1999-08-13 15:07:02 -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
cb010d75da [svn-r1550] VLdatatypes.html
Removed H5Pset_vlen_mem_manage_type; it is no longer
	in the specification.

RM_H5P.html
	Added H5Pset_vlen_mem_manager.
1999-07-30 12:40:10 -05:00
Frank Baker
b3491fd4d1 [svn-r1540] RM_H5D.html
Correct spelling error in H5Dget_vlen_buf_size.
1999-07-23 18:15:09 -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
80c105b802 [svn-r1529] Palettes.html
Fixed image pathnames.

PaletteExample1.gif
Palettes.fm.anc.gif
	Images for Palettes.html.
1999-07-22 16:12:55 -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
2f3da042cf [svn-r1524]
RM_H5R.html
   H5Rget_region
	Removed "Not yet implemented" note.
	Corrected syntax to agree with description in H5R.c
	Added mention of valid 'ref_type' value; deleted reference to User's Guide.
   H5Rdereference
	Added list of valid 'ref_type' values; deleted reference to User's Guide.

RM_H5T.html
   H5Tget_class
	Added H5T_ENUM and H5T_REFERENCE to list of return values.
   H5Topen
	Corrected description of 'loc_id'; clarified description of 'name'.
   H5Tinsert
	Corrected 'offset' datatype.

RM_H5P.html
Datasets.html
   Fixed minor formatting errors.
   H5Pset_layout
   H5Pget_layout
	Added comment that H5D_COMPACT layout type is not yet implemented.
   H5Pset_external
	Added note regarding setting 'size' to H5F_UNLIMITED.
   H5Pset_family                                           (RM_H5P.html only)
	Removed extra function entry ('original version').
   H5Pget_split                                            (RM_H5P.html only)
	Corrected pair of typos in 'meta_ext' description.
1999-07-21 15:46:42 -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
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
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
Patrick Lu
b1a4689964 [svn-r1383]
updated the enum data entry
1999-06-25 13:54:36 -05:00
Patrick Lu
8c11a3a87c [svn-r1378]
added references and enums into the list of datatypes displayed
1999-06-24 14:54:34 -05:00
Patrick Lu
c04c1b6abf [svn-r1375]
updated the ddl so it has the new types that we are displaying in dumper
1999-06-24 13:52:06 -05:00
Robb Matzke
1c5f6ffb70 [svn-r1341]
Changes since 19990611
----------------------

./doc/html/H5.format.html
	Added documentation for opaque data types (bitfield types were
	already documented but they were out of order).

./src/H5E.c
	Fixed a bug with glibc2 on linux systems where `stdout' is an
	extern and can't be used to initialize static data.

./src/H5T.c
./src/H5Tpkg.h
./src/H5Tpublic.h
./src/H5detect.c
	Removed the `_T' from the new C9x types I just added so the
	names are consistent with existing types. Besides, the fact
	that something is a datatype is obvious because it starts with
	H5T_NATIVE_.

./tools/h5ls.c
	Added the new C9x data types. H5ls prints one of these types
	only if it doesn't match one of the builtin C types.

	Prints the OID for shared data types.

	Fixed a formatting bug with symbolic links which was
	introduced a few changes ago.

	The commandline has been changed so that objects from multiple
	files can be listed with a single command. Instead of
	specifying a file name and an optional list of objects, each
	thing to print is a file name and object concatenated. H5ls
	figures out how to devide the name into a file name and object
	name even when the file name part doesn't correspond to an
	actual Unix file.

	   Old syntax: h5ls [OPTIONS] FILE [OBJECTS]
	   New syntax: h5ls [OPTIONS] FILE[/OBJECT] [FILE[/OBJECT]]...

	   Example ({X,Y} is expanded by the shell)

	   Old command: h5ls -d ../test/x.data dir1 dir2
	   New command: h5ls -d ../test/x.data/{dir1,dir2}

	The filename is printed as part of the object name when full
	names are requested (--full or --recursive). If people really
	don't like this they can undefine a constant at the top of
	h5ls.

	Errors from the hdf5 library are turned off.

	Commandline switches of the form `--width 80' are accepted in
	addition to `--width=80'. This is more symmetric with
	single-letter switches that take two forms: `-w 80' and
	`-w80'.

./src/H5D.c
	Added tracing instrumentation for H5Dvlen_reclaim().

./src/H5private.h
	Added casts to int for the isalpha() et al macros to shut up
	solaris warnings about char subscripts.
1999-06-14 10:07:58 -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
Robb Matzke
e352d29757 [svn-r1292] Changes since 19990430
----------------------

Remove changes from CVS

./bin/release
	Added a `--nocheck' switch which causes the script to not
	check the contents of the MANIFEST file against CVS. This is
	sometimes useful when you need to make a quick snapshot but
	the MANIFEST file is not quite up to date.

./src/H5D.c
	Removed warnings for unused variables

./src/H5Fprivate.h
	Removed the WIN32 definition for `uint' and changed the data
	type for `eof_written' from `uint' to `uintn'. Shouldn't this
	really be `hbool_t'?

./src/H5Odtype.c
./src/H5T.c
./src/H5Tconv.c
./src/H5Tpkg.h
./src/H5Tpublic.h
./test/dtypes.c
./doc/html/H5.format.html
	Added support for bitfields and opaque data types.
1999-06-02 08:59:35 -05:00
Frank Baker
de0d96dd53 [svn-r1287]
Attributes.html
RM_H5A.html
	Fix bug #326, which pointed out that the H5Aget_name parameters were
	listed in the wrong order.
1999-05-28 15:09:10 -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
Albert Cheng
35747cccd7 [svn-r1242] Updated the syntax of the H5Sselect_hyperslab calls.
(This file may have been replaced by multiple files already.)
1999-04-30 15:46:45 -05:00
Frank Baker
62f0caf0a5 [svn-r1221] Fixed Bug #293
RM_H5Front.html
		"H5A Annotation" Interface corrected to "H5A Attribute" interface.
	RM_H5G.html
		H5Glink loc_id description corrected.
1999-04-26 17:16:42 -05:00