[svn-r11702] Purpose:

    Light edit and consistency formatting.
Platforms tested:
    Viewed in vi.

1 files changed, 102 insertions, 100 deletions

diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index ce2a573..6fd2d84 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -4,8 +4,8 @@ HDF5 version 1.6.5-pre4 currently under development
 INTRODUCTION
 ============
 This document describes the differences between HDF5-1.6.4 and
-HDF5-1.6.4-post*, and contains information on the platforms tested and
-known problems in HDF5-1.6.4. For more details check the HISTORY.txt
+HDF5-1.6.4-post*.  It contains information on the platforms tested and
+known problems in HDF5-1.6.5. For more details, check the HISTORY.txt
 file in the HDF5 source.
 
 The HDF5 documentation can be found on the NCSA ftp server
@@ -13,8 +13,12 @@ The HDF5 documentation can be found on the NCSA ftp server
 
      /HDF/HDF5/docs/
 
+Documentation for the current release is also on the HDF web site:
+
+     http://hdf.ncsa.uiuc.edu/HDF5/doc/
+
 For more information look at the HDF5 home page at:
-   
+
     http://hdf.ncsa.uiuc.edu/HDF5/
 
 If you have any questions or comments, please send them to:
@@ -25,7 +29,7 @@ If you have any questions or comments, please send them to:
 CONTENTS
 ========
 - New Features
-- Support for new platforms and languages
+- Support for New Platforms, Languages and Compilers
 - Bug Fixes since HDF5-1.6.4
 - Documentation
 - Platforms Tested
@@ -47,65 +51,66 @@ New Features
     -------------------------
 	- Added g95 as a testing "platform" informally. AKC - 2005/10/04.
         - Added MD5 checksumming to snapshot releases.  Releases will now
-          produce a .md5 file as well as a .tar archive.  md5sum can be
+          produce an .md5 file as well as a .tar archive.  md5sum can be
           used to verify the arvhice with the .md5 checksum.  -JL 2005/09/06
 
     Library:
     --------
-       - Added HSYS_ERROR which retrieves the system error message and pushes
-         it to the error stack.  This gives more information of the failed
-	 system call. AKC - 2005/08/04
-       - Added H5F_OBJ_LOCAL flag to H5Fget_obj_count() & H5Fget_obj_ids(), to
-          allow querying for objects in file that were opened with a particular
-          file ID, instead of all objects opened in file with any file ID.
+        - Added HSYS_ERROR which retrieves the system error message and pushes
+          it to the error stack.  This provides more information regarding the 
+	  failed system call. AKC - 2005/08/04
+        - Added H5F_OBJ_LOCAL flag to H5Fget_obj_count() & H5Fget_obj_ids(), to
+          allow querying for objects in a file that was opened with a particular
+          file ID, instead of all objects opened in the file with any file ID.
           QAK - 2005/06/01
 
     Parallel Library:
     -----------------
 	- Added mpich2 as a testing "platform" informally. AKC - 2005/10/04.
 	- HDF5 supports collective MPI-IO for irregular selection with HDF5
-          dataset. Irregular selection is when users use API H5Sselect_hyperslab
-          more than once for the same dataset.
-          Currently, not all MPI-IO packages support complicated MPI derived
-	     datatype used in the implementation of irregular
-	     selection INSIDE HDF5. 
-	     1) DEC 5.x is not supporting complicated derived datatype.
-	     2) For AIX 5.1,
-	     if your poe version number is 3.2.0.20 or lower,
-	     please edit powerpc-ibm-aix5.x under hdf5/config,
+	  dataset. Irregular selection is when users use API H5Sselect_hyperslab
+	  more than once for the same dataset.
+	  Currently, not all MPI-IO packages support the complicated 
+	  MPI derived datatypes used in the implementation of irregular 
+	  selections INSIDE HDF5. 
+	  1) DEC 5.x wdoes not support complicated derived datatypes.
+	  2) For AIX 5.1:
+	     If your poe version number is 3.2.0.20 or lower,
+	     please edit powerpc-ibm-aix5.x in the directory hdf5/config/.
 	     Find the line with
-		    << hdf5_mpi_complex_derived_datatype_works>>
+	          << hdf5_mpi_complex_derived_datatype_works >>
 	     and UNCOMMENT this line before the configure.
 	     check poe version with the following command:
 	     lpp -l all | grep ppe.poe
-	     3) For Linux cluster, 
-		if mpich version is 1.2.5 or lower, collective irregular selection
-		IO is not supported, internally independent IO is used.
-	     4) For IRIX 6.5,
-		if C compiler version is 7.3 or lower, collective irregular selection
-		IO is not supported, internally independent IO is used.
-	     5) For platforms which internally used mpich, if the
-		mpich version is 1.2.5 or lower, please find the 
-		corresponding config file and add
-		hdf5_mpi_complex_derived_datatype_works='no' at the
-		end of the configuration file. For example, at NCSA
-		SGI Altix, the internal mpich library is 1.2.5. So 
-		hdf5_mpi_complex_derived_datatype_works='no' should be
-		added at the end of the config file ia64-linux-gnu.
-		 KY - 2005/09/12
+	  3) For Linux cluster,:
+	     If mpich version is 1.2.5 or lower, collective irregular selection
+	     IO is not supported; internally independent IO is used.
+	  4) For IRIX 6.5:
+	     if C compiler version is 7.3 or lower, collective irregular 
+	     selection IO is not supported; internally independent IO is used.
+	  5) For platforms which internally used mpich: 
+	     If the mpich version is 1.2.5 or lower, please find the 
+	     corresponding config (in hdf5/config) file and add
+	         hdf5_mpi_complex_derived_datatype_works='no' 
+	     at the end of the configuration file. For example, on the 
+	     NCSA SGI Altix, the internal mpich library is 1.2.5. So 
+	         hdf5_mpi_complex_derived_datatype_works='no' 
+	     should be added at the end of the config file ia64-linux-gnu.
+	     KY - 2005/09/12
+
     Tools:
     ------
-	- Removed obsolete pdb2hdf tool.  JML - 2005/10/28
+        - Removed obsolete pdb2hdf tool.  JML - 2005/10/28
         - Sped up h5dump on files with large numbers of objects.
             QAK - 2005/08/25
 
     F90 API:
     --------
-     - Added missing h5tget_member_class_f function
+        - Added missing h5tget_member_class_f function
                                             EIP 2005/04/06
     C++ API:
     --------
-	- Added missing member functions
+        - Added missing member functions:
 		H5::CompType::getMemberArrayType
 		H5::CompType::getMemberVarLenType
 		H5::AbstractDs::getArrayType
@@ -118,8 +123,8 @@ New Features
 		BMR - 2005/07/27
 
 
-Support for new platforms, languages and compilers.
-=======================================
+Support for New Platforms, Languages and Compilers
+==================================================
     - Added support for RedStorm platform (serial only.)  AKC 2005/11/10
     - Added support for BG/L platform (serial only.)  LA 2005/11/10
     - Added support for HPUX 11.23 (IA64); only C and C++ are supported
@@ -132,28 +137,27 @@ Support for new platforms, languages and compilers.
         - Added support for Cray X1.  JML 2005/10/03
 
 
-Bug Fixes since HDF5-1.6.4 release
+Bug Fixes since HDF5-1.6.4 Release
 ==================================
 
     Library
     -------
-        - Fixed collective IO in chunking-storage. The dataspace  for each
-          chunk is different with the dataspace for the whole file or buffer.
-          It may call the wrong routine when the shape of the dataspace in
-          file and in chunk is different. This bug was fixed to make sure
-          the correct routine is called. KY - 2005/10/19
+        - Fixed collective IO in chunking-storage.  HDF5 may have called the 
+            wrong routine when the shape of the dataspace in the file and in 
+            the bufferred chunk were different. This bug was fixed to make sure
+            the correct routine is called. KY - 2005/10/19
         - Fixed core dump when closing root groups opened through two different
             file handles that operate on the same actual file.  QAK - 2005/10/02
-	- The ./dsets tests used to fail in the TFLOPS machine if the
-	  test program, dsets.c, was compiled with the -O option.
-	  The hdf5 library still worked correctly with the -O option. Only
-	  the ./dsets failed.  It is fixed. AKC - 2005/09/14
+        - The ./dsets tests used to fail in the TFLOPS machine if the
+            test program, dsets.c, was compiled with the -O option.
+            The HDF5 library still worked correctly with the -O option. Only
+            the ./dsets failed.  It is fixed. AKC - 2005/09/14
         - Corrected errors when performing various operations on a group opened
             by dereferencing an object reference.  QAK - 2005/07/30
         - Fixed a bug with named datatypes where a copy of a named datatype
             used to create a dataset would accidentally use the original
             named datatype for the dataset's datatype.  QAK - 2005/07/23
-        - Made H5Fget_name() be consistent and always return name of actual
+        - Made H5Fget_name() to be consistent and always return name of actual
             file the ID is in.  (Instead of the name of the top file in a
             file mounting hierarchy).  QAK - 2005/07/19
         - Reworked internal file mounting semantics to hopefully eliminate
@@ -161,12 +165,10 @@ Bug Fixes since HDF5-1.6.4 release
             together all have the same "file close degree".  QAK - 2005/07/19
         - More bug fixes on holding open files that are mounted and have
             IDs open.  QAK - 2005/07/14
-        - More bug fixes on holding open files that are mounted and have
-            IDs open.  QAK - 2005/07/14
-        - Dataset sieve buffer cache was inadvertantly disabled - re-enable 
-            it.  QAK - 2005/07/08
+        - Dataset sieve buffer cache was inadvertantly disabled; it has been
+            re-enabled.  QAK - 2005/07/08
         - Don't unmount child files until the parent file actually closes.
-            (Previously, if an object is holding open a file, the child files
+            (Previously, if an object was holding open a file, the child files
             would get unmounted too early).  QAK - 2005/07/05
         - Fixed bug where unmounted files could cause the library to go into
             an infinite loop when shutting down.  QAK - 2005/06/30
@@ -182,7 +184,7 @@ Bug Fixes since HDF5-1.6.4 release
         - "SEMI" and "STRONG" file close degree settings now apply only to the
             particular file ID being closed, instead of operating on all open
             file IDs for a given file.  QAK - 2005/06/01
-        - Fixed error in opening object in group that was opened in mounted
+        - Fixed error in opening object in a group that was opened in a mounted
             file which has been unmounted.  QAK - 2005/03/17
 
     Configuration
@@ -195,8 +197,8 @@ Bug Fixes since HDF5-1.6.4 release
 
     Performance
     -------------
-        - Optimized I/O for enumerated datatypes that are a superset of source
-            enumerated datatype.  QAK - 2005/03/19
+        - Optimized I/O for enumerated datatypes that are a superset of a 
+            source enumerated datatype.  QAK - 2005/03/19
    
     Tools
     -----
@@ -207,9 +209,8 @@ Bug Fixes since HDF5-1.6.4 release
     F90 API
     -------
        - h5pget_driver_f was returning information that could not be
-         interpreted by fortran application program; fixed. EIP - 2005/04/10
+         interpreted by a Fortran application program; fixed. EIP - 2005/04/10
                                 
-
     C++ API
     -------
 	- Several member functions' prototype changed due to the 
@@ -412,12 +413,11 @@ Footnotes:  (1) Using mpich 1.2.6
                 and Intel compilers
             (7) Linux 2.4.21, SuSE_292.til1.  Ia64 cluster with Intel compilers
             (8) Intel 8.1
-            (9) We found one test of this release failed with compaq visual
-                fortran 6.6c.
-                We won't provide binary fortran release. Users should build
-                the library by themselves and use with their own risks. We
-                recommend users to use HDF5 1.7 instead.
-                HDF5 1.7 or use compaq visual fortran 6.0.
+            (9) One test of this release failed with Compaq Visual Fortran 6.6c.
+                No binary fortran release will be provided. Users should build
+                the library by themselves and use it at their own risk. 
+                We recommend that users use HDF5 1.7 instead 
+                or use Compaq Visual Fortran 6.0.
            (10) IBM XLF and Absoft
            (11) PGI, Absoft.  No shared libraries with Absoft; 
                 use '--disable-shared'.
@@ -425,8 +425,8 @@ Footnotes:  (1) Using mpich 1.2.6
            (13) AMD Opteron x86_64
            (14) ifort
            (15) Yes with C and Fortran, but not with C++
-	   (16) Only serial is ported.  PFS does not work for PHDF5 yet.
-       FMB/EIP - 2005/11/10
+           (16) Only serial is ported.  PFS does not work for PHDF5 yet.
+           FMB/EIP - 2005/11/10
 
 
 Known Problems
@@ -440,19 +440,20 @@ Known Problems
   1. Compaq visual fortran 6.6c with VS 6.0
      The Fortran tests failed for both release, release dll, debug and debug
      dll. The failure is a random one. We won't provide fortran libraries. The
-     same test passed with 1.7.51 snapshot. You may find the 1.7.51 snapshot
-     under ftp://hdf.ncsa.uiuc.edu/pub/outgoing/hdf5/snapshots/
+     same test passed with the 1.7.51 snapshot. You may find the 1.7.51 
+     snapshot under ftp://hdf.ncsa.uiuc.edu/pub/outgoing/hdf5/snapshots/.
   2. Intel fortran 8.1 under .Net environment
      The fortran library cannot even be compiled. Some users have pointed this
      to intel forum.
+
 * When testing parallel HDF5 with the C compiler version MIPSpro 7.4.3 at IRIX
-  6.5, set enviroment variable MPI_TYPE_MAX to be a bigger number, for example 120000 
-  in order to pass the complicated collective IO tests inside parallel HDF5
-  library. This is not a problem inside parallel HDF5 library. You can always
-  set a bigger number in your system.
+  6.5, set enviroment variable MPI_TYPE_MAX to be a bigger number, for example 
+  120000, in order to pass the complicated collective IO tests inside parallel 
+  HDF5 library. This is not a problem inside parallel HDF5 library. You can 
+  always set a bigger number in your system.
                                   KY - 2005/10/6
 
-* Contiguous or chunked dataset created by a sequential version may
+* A contiguous or chunked dataset created by a sequential version may
   not be modified with a parallel version of the library. 
   Use the H5Pset_alloc_time function with H5D_ALLOC_TIME_EARLY to set up the 
   dataset creation property list to avoid the problem.
@@ -468,13 +469,14 @@ Known Problems
   after 1.6.4 can still read the dataset created or rewritten with the library
   of v1.6.2 or before.  SLU - 2005/7/8
 
-* For the version 6(6.02 and 6.04) of Portland Group compiler on AMD Opteron
+* For version 6 (6.02 and 6.04) of the Portland Group compiler on AMD Opteron
   processor, there's a bug in the compiler for optimization(-O2).  The library
   failed in several tests but all related to multi driver.  The problem has 
   been reported to the vendor.  
+
 * test/big fails sometimes with the message "Possible overlap with another
   region."  The test selects regions randomly, and this error occurs when
-  two regions overlap each other; it is an bug in the test and not in
+  two regions overlap each other; it is a bug in the test and not in
   HDF5.  Since the error is triggered by a random situation, it will
   usually disappear if the test is re-run.
 
@@ -496,11 +498,11 @@ Known Problems
   Check if there are many old /tmp/s.pedb.* staying around.  These are
   sockets used by the poe command and left behind due to failed commands.
   Ask your system administrator to clean them out.  Lastly, request IBM
-  to provide a mean to run poe without the debug socket.
+  to provide a means to run poe without the debug socket.
 
-* There are two h5dump xml tests(h5dump --xml thlink.h5 and 
-  h5dump --xml tmany.h5) failed on windows xp with .NET for debug and 
-  debug dll. Release and Release dll work fine. 
+* Two h5dump xml tests(h5dump --xml thlink.h5 and h5dump --xml tmany.h5) 
+  failed on windows xp with .NET for debug and debug dll. Release and 
+  Release dll work fine. 
 
 * The h5dump tests may fail to match the expected output on some platforms
   (e.g. parallel jobs, Windows) where the error messages directed to
@@ -541,16 +543,16 @@ Known Problems
   from the site:
   ftp://ftp.ncsa.uiuc.edu/HDF/HDF5/current/src/patches/
 
-* On some platforms that use Intel and Absoft compilers to build HDF5 fortran 
-  library, compilation may fail for fortranlib_test.f90, fflush1.f90 and 
-  fflush2.f90 complaining about exit subroutine. Comment out the line 
-  IF (total_error .ne. 0) CALL exit (total_error)
+* On some platforms that use Intel and Absoft compilers to build the HDF5 
+  fortran library, compilation may fail for fortranlib_test.f90, fflush1.f90 
+  and fflush2.f90 complaining about exit subroutine. Comment out the line 
+  IF (total_error .ne. 0) CALL exit (total_error).
 
 * Use --disable-shared configure flag if building with Absoft Fortran
-  compiler
+  compiler.
 
 * Information about building with PGI and Intel compilers is available in
-  INSTALL file sections 5.7 and 5.8
+  INSTALL file sections 5.7 and 5.8.
 
 * In LANL QSC, the new cc compiler has problems converting small values of
   long long (absolute values less than 1**-308) to double.  This triggers
@@ -561,22 +563,22 @@ Known Problems
   occasionally as 1**-308.  This has been reported to the system staff.
   All other tests have passed.
 
-* The C++ library's tests fails when compiling with PGI C++ compiler.  The
+* The C++ library's tests fail when compiling with PGI C++ compiler.  The
   workaround until the problem is correctly handled is to use the
-  flag "--instantiate=local" prior to the configure and build steps, as:
+  flag "--instantiate=local" prior to the configure and build steps, as follows:
         setenv CXX "pgCC --instantiate=local"  for pgCC 5.02 and higher
         setenv CXX "pgCC -tlocal" for others
 
-* Fortran release DLL randomly failed with compaq visual fortran 6.6c on
-  windows. 
+* Fortran release DLL randomly failed with Compaq Visual Fortran 6.6c on
+  Windows. 
 
 * Fortran DLL built with Intel 8.1 in .NET environment crushed the compiler,
-  To build Fortran Static library with Intel 8.1 in .NET environment 
-  needs manually setting the project file,
-  please contact to hdfhelp@ncsa.uiuc.edu if you need to build
-  fortran static library with Intel 8.1 with .NET environment.
+  Building Fortran static library with Intel 8.1 in .NET environment 
+  requires manually setting the project file.
+  Please contact to hdfhelp@ncsa.uiuc.edu if you need to build
+  Fortran static library with Intel 8.1 with .NET environment.
 
-* On at least one system, (SDSC DataStar), the scheduler (in this case
+* On at least one system, SDSC DataStar, the scheduler (in this case
   LoadLeveler) sends job status updates to standard error when you run
   any executable that was compiled with the parallel compilers.
 
@@ -625,8 +627,8 @@ Known Problems
   "unsetenv RUNSERIAL" before running configure for a serial build.
 
   Note that the RUNSERIAL environment variable exists so that we can
-  can prefix serial runs as necessary on the target system.  On DataStar,
-  no prefix is necessary.  However on an MPICH system, the prefix might
+  prefix serial runs as necessary on the target system.  On DataStar,
+  no prefix is necessary.  However, on an MPICH system, the prefix might
   have to be set to something like "/usr/local/mpi/bin/mpirun -np 1" to
   get the serial tests to run at all.