From 19d5d5f2d326dd2dcd7e1793884b0836df2d0bcc Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Mon, 23 Jun 2003 15:35:51 -0500 Subject: [svn-r7086] 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 --- doc/html/RM_H5.html | 44 +++++++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index bf1976b..c5c1bcc 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -127,7 +127,7 @@ facilitate moving easily between them.        @@ -211,10 +211,23 @@ facilitate moving easily between them.
Description:
H5set_free_list_limits sets size limits on all types of free lists. - Free lists are - - ... just what, exactly? - + The HDF5 library uses free lists internally to manage memory. + There are three types of free lists: + + Alternate phrasing?: +

These are global limits, but each limit applies only to free lists of the specified type. @@ -227,33 +240,26 @@ facilitate moving easily between them. no limit is set for the specified type of free list.

Parameters:
- -
- Why is regular quoted below? - What would be, say, irregular? - -
int reg_global_lim -
IN: The limit on all "regular" free list memory used +
IN: The limit on all regular free list memory used
int reg_list_lim -
IN: The limit on memory used in each "regular" free list +
IN: The limit on memory used in each regular free list
int arr_global_lim -
IN: The limit on all "array" free list memory used +
IN: The limit on all array free list memory used
int arr_list_lim -
IN: The limit on memory used in each "array" free list +
IN: The limit on memory used in each array free list
int blk_global_lim -
IN: The limit on all "block" free list memory used +
IN: The limit on all block free list memory used
int blk_list_lim -
IN: The limit on memory used in each "block" free list +
IN: The limit on memory used in each block free list
Returns:
Returns a non-negative value if successful; otherwise returns a negative value. - -- cgit v0.12