diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 18d23b5d15..6e2d886528 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -62,6 +62,7 @@ and it users.
H5garbage_collect
(void)
+H5garbage_collect
walks through all the garbage
+ collection routines of the library, freeing any unused memory.
+
+ It is not required that H5garbage_collect
be called
+ at any particular time; it is only necessary in certain situations
+ where the application has performed actions that cause the library
+ to allocate many objects. The application should call
+ H5garbage_collect
if it eventually releases those
+ objects and wants to reduce the memory used by the library from
+ the peak usage required.
+
+ The library automatically garbage collects all the free lists + when the application ends. +