[svn-r27869] Update with changes to script file

1 files changed, 22 insertions, 11 deletions

diff --git a/config/cmake/README.txt.cmake.in b/config/cmake/README.txt.cmake.in
index a12c5aa..ec40abe 100644
--- a/config/cmake/README.txt.cmake.in
+++ b/config/cmake/README.txt.cmake.in
@@ -1,11 +1,11 @@
 @HDF5_PACKAGE_NAME@ version @HDF5_PACKAGE_VERSION_STRING@
 ------------------------------------------------------------------------------
 
-This directory contains the binary (release) distribution of 
+This directory contains the binary (release) distribution of
 @HDF5_PACKAGE_NAME@ @HDF5_PACKAGE_VERSION_MAJOR@ that was compiled on;
-    @BINARY_PLATFORM@. 
+    @BINARY_PLATFORM@.
 
-It was built with the following options: 
+It was built with the following options:
     -- @LIB_TYPE@ C/C++/Fortran libraries
     -- SZIP (encoder enabled) and ZLIB
     -- @LIB_TYPE@ HDF5 tools
@@ -24,27 +24,38 @@ Installation
 
 After Installation
 ===========================================================================
-The examples folder, HDF5Examples, located in the 
+The examples folder, HDF5Examples, located in the
 HDF5 install folder, can be built and tested with CMake and the supplied
 HDF5_Examples.cmake file. The HDF5_Examples.cmake expects HDF5 to have
-been installed in the default location with above compilers. Also, the CMake 
+been installed in the default location with above compilers. Also, the CMake
 utility should be installed.
 
 To test the installation with the examples;
     Create a directory to run the examples.
     Copy HDF5Examples folder to this directory.
     Copy HDF5_Examples.cmake to this directory.
-    Edit HDF5_Examples.cmake line 8 to set INSTALLDIR to where HDF5 is installed.
-       (The default should be correct unless you installed into a different folder.)
-    Execute from this directory: 
-        ctest -S HDF5_Examples.cmake,HDF5Examples -C Release -V -O test.log
+    The default source folder is defined as "HDF5Examples". It can be changed
+        with the CTEST_SOURCE_NAME script option.
+    The default installation folder is defined as "@CMAKE_INSTALL_PREFIX@".
+        It can be changed with the INSTALLDIR script option.
+    The default ctest configuration is defined as "Release". It can be changed
+        with the CTEST_BUILD_CONFIGURATION script option. Note that this must
+        be the same as the value used with the -C command line option.
+    The default build configuration is defined to build and use static libraries.
+        Shared libraries can be used with the STATICLIBRARIES script option set to "NO".
+    Other options can be changed by editing the HDF5_Examples.cmake file.
+
+    If the defaults are okay, execute from this directory:
+        ctest -S HDF5_Examples.cmake -C Release -V -O test.log
+    If the defaults need change, execute from this directory:
+        ctest -S HDF5_Examples.cmake,CTEST_SOURCE_NAME=MyExamples,INSTALLDIR=MyLocation -C Release -V -O test.log
 
 When executed, the ctest script will save the results to the log file, test.log, as
-indicated by the ctest command. If you wish the to see more build and test information, 
+indicated by the ctest command. If you wish the to see more build and test information,
 add "-VV" to the ctest command. The output should show;
       100% tests passed, 0 tests failed out of 156.
 
-For more information see USING_CMake_Examples.txt in the install folder. 
+For more information see USING_CMake_Examples.txt in the install folder.
 ===========================================================================
 
 Documentation for this release can be found at the following URL: