[svn-r4219] Purpose:

    Linking to new "Freespace Management" section from appropriate places.
Description:
    Added links, with explanatory paragraph or footnote,
    from Chunking.html, Filters.html, and H5Gunlink in RM_H5G.html
    to "Freespace Management" in Performance.html.
Platforms tested:
    IE 5

4 files changed, 42 insertions, 12 deletions

diff --git a/doc/html/Chunking.html b/doc/html/Chunking.html
index 38670a8..0939d59 100644
--- a/doc/html/Chunking.html
+++ b/doc/html/Chunking.html
@@ -58,6 +58,7 @@
       <li><a href="#S3">3. Cache Efficiency</a>
       <li><a href="#S4">4. Fragmentation</a>
       <li><a href="#S5">5. File Storage Overhead</a>
+      <li><a href="#S6">6. Chunk Compression</a>
     </ul>
 
     <h2><a name="S1">1. Introduction</a></h2>
@@ -215,7 +216,22 @@
       <code>H5Pset_istore_k()</code> (increasing the out degree actually
       increases file overhead while decreasing the number of nodes).
 
-    <hr>
+
+    <h2><a name="S6">6. Chunk Compression</a></h2>
+
+    <p>Dataset chunks can be compressed through the use of filters.
+     See the chapter &ldquo;<a href="Filters.html">Filters in HDF5</a>.&rdquo;
+
+    <p>Reading and rewriting compressed chunked data can result in holes 
+     in an HDF5 file.  In time, enough such holes can increase the 
+     file size enough to impair application or library performance 
+     when working with that file.  See
+     &ldquo;<a href="Performance.html#Freespace">Freespace Management</a>&rdquo;
+     in the chapter
+     &ldquo;<a href="Performance.html">Performance Analysis and Issues</a>.&rdquo;
+
+
+<hr>
 
     <p><a name="fn1">Footnote 1:</a> Parallel versions of the library
       can access individual bytes of a chunk when the underlying file
@@ -224,7 +240,6 @@
     <p><a name="fn2">Footnote 2:</a> The raw data chunk cache was
       added before the second alpha release.
 
-
 <hr>
 <center>
 <table border=0 width=98%>
@@ -273,7 +288,7 @@
 
 <!-- Created: Tue Oct 20 12:38:40 EDT 1998 -->
 <!-- hhmts start -->
-Last modified:  16 February 2001
+Last modified:  11 July 2001
 <!-- hhmts end -->
 
 <br>
diff --git a/doc/html/Filters.html b/doc/html/Filters.html
index f7cd7f9..bf3f55a 100644
--- a/doc/html/Filters.html
+++ b/doc/html/Filters.html
@@ -55,7 +55,8 @@
 
     <h2>1. Introduction</h2>
 
-    <p>HDF5 allows chunked data to pass through user-defined filters
+    <p>HDF5 allows chunked data<sup><a href="#fn1">1</a></sup> 
+      to pass through user-defined filters
       on the way to or from disk.  The filters operate on chunks of an
       <code>H5D_CHUNKED</code> dataset can be arranged in a pipeline
       so output of one filter becomes the input of the next filter.
@@ -507,6 +508,21 @@ H5Z: filter statistics accumulated over life of library:
 
 
 <hr>
+
+
+    <p><a name="fn1">Footnote 1:</a> Dataset chunks can be compressed 
+     through the use of filters.  Developers should be aware that 
+     reading and rewriting compressed chunked data can result in holes 
+     in an HDF5 file.  In time, enough such holes can increase the 
+     file size enough to impair application or library performance 
+     when working with that file.  See
+     &ldquo;<a href="Performance.html#Freespace">Freespace Management</a>&rdquo;
+     in the chapter
+     &ldquo;<a href="Performance.html">Performance Analysis and Issues</a>.&rdquo;
+
+
+
+<hr>
 <center>
 <table border=0 width=98%>
 <tr><td valign=top align=left>
@@ -554,7 +570,7 @@ H5Z: filter statistics accumulated over life of library:
 
 <!-- Created: Fri Apr 17 13:39:35 EDT 1998 -->
 <!-- hhmts start -->
-Last modified:  17 December 1999
+Last modified:  11 July 2001
 <!-- hhmts end -->
 
 <br>
diff --git a/doc/html/Performance.html b/doc/html/Performance.html
index 079d991..f21858a 100644
--- a/doc/html/Performance.html
+++ b/doc/html/Performance.html
@@ -63,7 +63,9 @@
       <a href="Chunking.html">Dataset Chunking Issues</a> elsewhere
       in this <cite>User's Guide</cite>.
 
+    <a name="Freespace">
     <h2>3. Freespace Management</h2>
+    </a>
 
      <p>HDF5 does not yet manage freespace as effectively as it might.
       While a file is opened, the library actively tracks and re-uses
diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html
index 27e6159..5511239 100644
--- a/doc/html/RM_H5G.html
+++ b/doc/html/RM_H5G.html
@@ -365,14 +365,11 @@ create or access function.
         If the any object identifier is open for the object, the space
         will not be released until after the object identifier is closed.
         <p>
-        <!-- editingcomment: freespace and file packing -->
         Note that space identified as freespace is available for re-use 
         only as long as the file remains open; once a file has been 
-        closed, the HDF5 library loses track of freespace. 
-        Identifying freespace does not imply that the file
-        will be packed or that, if the file is closed and later reopened,
-        that the space will be available for re-use.  
-        Such functionality has not yet been implemented in the HDF5 library.
+        closed, the HDF5 library loses track of freespace.  See
+        &ldquo;<a href="Performance.html#Freespace">Freespace Management</a>&rdquo;
+        in the <cite>HDF5 User's Guide</cite> for further details.
   <dt><strong>Warning:</strong>
     <dd>Exercise care in unlinking groups as it is possible to render data in 
         a file inaccessible with <code>H5Gunlink</code>.  
@@ -828,7 +825,7 @@ H5G&nbsp;&nbsp;
 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> 
 
 <br>
-Last modified:  6 July 2001
+Last modified:  11 July 2001
 <br>
 Describes HDF5 Release 1.4.2, July 2001