[svn-r7288] Purpose:

Add more contents about szip


Description:
Describe where to find szip and how to turn off szip compression.

Solution:

Platforms tested:

Misc. update:

1 files changed, 46 insertions, 16 deletions

diff --git a/release_docs/INSTALL_Windows.txt b/release_docs/INSTALL_Windows.txt
index 1a712f5..9cd69d3 100644
--- a/release_docs/INSTALL_Windows.txt
+++ b/release_docs/INSTALL_Windows.txt
@@ -19,22 +19,33 @@ Preconditions
 	    c:\					(any drive)
 	   MyHDFstuff\				(any folder name)
 
+   3. Download the hdf5xxx distribution archive and use WinZip to
+      extract the hdf5 package into c:\MyHDFstuff.  This creates a 
+      directory called 'hdf5xxx' under MyHDFstuff which contains
+      several files and directories. Rename "hdf5xxx" to "hdf5".  
+
    4. HDF5 uses zlib for compression and zlib is NOT distributed 
-      with hdf5 lib in 1.6.??? release. You have to install your own
+      with hdf5 lib in 1.6.0 release. You have to install your own
       zlib library or you may go to HDF web site
 	(ftp://ftp.ncsa.uiuc.edu/HDF/gzip/) 
       to download the correponding zlib library by yourself. If you 
       want to build HDF5 library without using zlib, please read section V.
 
-   5. HDF4-related tools are not built and released with HDF5 library
+   5. HDF5 uses szlib(szip) for compression and szlib is distributed with hdf5 lib
+      in 1.6.0 release. You can also download szlib source codes and binaries from
+      ftp://ftp.ncsa.uiuc.edu/HDF/szip/windows/
+      If you want to build HDF5 library without using szlib, please read
+      section V.
+
+   6. HDF4-related tools are not built and released with HDF5 library
       packages any more. To obtain HDF4-related tools, please check
       http://hdf.ncsa.uiuc.edu/h4toh5/ and ftp://hdf.ncsa.uiuc.edu/HDF5/h4toh5/
 
-   6. For .NET users, please go to section VI.
+   7. For .NET users, please go to section VI.
 
-   7. For DLL users, please do read and follow "DLL hints" at Section IV.
+   8. For DLL users, please do read and follow "DLL hints" at Section IV.
 
-   8. For users who would like to build, test and use HDF5 snapshot release, please
+   9. For users who would like to build, test and use HDF5 snapshot release, please
       read Section VII.
 
 
@@ -42,7 +53,7 @@ Preconditions
 
 The following sections discuss installation procedures in detail:
 
-  Section I: What do we build and install
+  Section I:  What do we build and install
   Section II: Building and testing hdf5 libraries and non-hdf4 
               related hdf5 tools 
                tools
@@ -78,7 +89,7 @@ What do we build and install?
 	non-hdf4 related tools 
 
  HDF5 library testing programs:
-      hdf5 library related comprehensive tests
+      hdf5 library comprehensive tests
 		
  HDF5 related tools testing programs:
 	hdf5 tools testing programs
@@ -120,18 +131,22 @@ STEP 1: Building hdf5 libraries and non-hdf4 related tools
        see whether the zlib dll library path is the same as C:\zlib114\dll
        or the correct path where you install your dll export library.
        If not, replace the old zlib dll library path with the correct path.
+       check the same path for szlib dll.
 
        You should do this for both Debug and release version.
 
     4. Go to "Tools" and select "Options", find "Directories";
         4.1 Find the box "Show directories for", choose "Include files",
-            If you cannot find your zlib header path(for example, C:\zlib114\include)
+            If you cannot find your zlib and szlib header path
+           (for example, C:\zlib114\include,C:\szlib\include)
 	    from the directory list,
-            add the header path(C:\zlib114\include) to the included directories.
+            add the header path(C:\zlib114\include,C:\szlib\include) to 
+            the included directories.
         4.2 Find the box "Show directories for", choose "Library files",
-            If you cannot find your zlib library path(for example, C:\zlib114\lib)
+            If you cannot find your zlib and szlib library path
+            (for example, C:\zlib114\lib,C:szlib\lib)
 	    from the directory list,
-            add the library path(C:\zlib114\lib) to the included directories.
+            add the library path(C:\zlib114\lib,C:\szlib\lib) to the included directories.
 
     5. Select "Build", then Select "Set Active Configuration".
 
@@ -602,18 +617,33 @@ If you would like to remove gzip compression from the hdf5 library
 follow the steps below.
 
 
-    1) Open the H5pubconf.h file from the src directory and remove the 
-    following four lines:
+    1) Open the H5pubconf.h file from the src directory and remove(or comment
+       out) the following two lines:
 
 		#define H5_HAVE_ZLIB_H 1
-		#define H5_HAVE_LIBZ 1
-		#define H5_HAVE_COMPRESS2 1
-		#define H5_HAVE_COMPRESSION 1
+		#define H5_HAVE_FILTER_DEFLATE 1
+
+    then save the file.
+	
+    2) run-compile HDF5 library according to the previous steps.
+
+Diable szip compression
+=============================================
+If you would like to remove szip compression from the hdf5 library  
+follow the steps below.
+
+
+    1) Open the H5pubconf.h file from the src directory and remove(or comment
+       out) the following two lines: 
+
+		#define H5_HAVE_SZLIB_H 1
+		#define H5_HAVE_FILTER_SZIP 1
 
     then save the file.
 	
     2) run-compile HDF5 library according to the previous steps.
 
+
 Section VI:
 
 How to build HDF5 in VS 7.0(.NET)