summaryrefslogtreecommitdiffstats
path: root/release_docs/USING_CMake_Examples.txt
diff options
context:
space:
mode:
authorDana Robinson <derobins@hdfgroup.org>2015-09-29 18:56:27 (GMT)
committerDana Robinson <derobins@hdfgroup.org>2015-09-29 18:56:27 (GMT)
commit5c0a8cc86ebe85e1b46e20f253f09c86bdc83169 (patch)
tree1281be3f8a32432ead139af7381426c0a9fe92d5 /release_docs/USING_CMake_Examples.txt
parent6f1dda474c22ee95b7cc132e703cd6a2ac596704 (diff)
downloadhdf5-5c0a8cc86ebe85e1b46e20f253f09c86bdc83169.zip
hdf5-5c0a8cc86ebe85e1b46e20f253f09c86bdc83169.tar.gz
hdf5-5c0a8cc86ebe85e1b46e20f253f09c86bdc83169.tar.bz2
[svn-r27912] Revert of r27887, which caused failures in the vds test. These
changes will be merged more carefully so we can more easily identify any errors that arise. Tested on: Ubuntu 15.04 (Linux 3.19 x86_64) w/ gcc 4.9.2 serial and parallel (w/ MPICH 3.1.4)
Diffstat (limited to 'release_docs/USING_CMake_Examples.txt')
-rw-r--r--release_docs/USING_CMake_Examples.txt57
1 files changed, 28 insertions, 29 deletions
diff --git a/release_docs/USING_CMake_Examples.txt b/release_docs/USING_CMake_Examples.txt
index a6854ae..d52a719 100644
--- a/release_docs/USING_CMake_Examples.txt
+++ b/release_docs/USING_CMake_Examples.txt
@@ -28,8 +28,8 @@ I. Preconditions
the HDF Install Utility (the *.msi file in the binary package for
Windows or the *.sh on Linux). If you are using a Windows platform,
you can obtain a pre-built Windows binary from The HDF Group's website
- at www.hdfgroup.org.
-
+ at www.hdfgroup.org. See Section "III. Common changes to the
+ HDF518_Examples.cmake file", for the line to change the location.
========================================================================
@@ -37,41 +37,40 @@ II. Building HDF5 Examples with CMake
========================================================================
Files in the HDF5 install directory:
- HDF5Examples folder
+ HDF5Examples-0.1.1-Source folder
HDF518_Examples.cmake
Default installation process:
Create a directory to run the examples, i.e. \test_hdf5.
- Copy HDF5Examples folder to this directory.
- Copy HDF5_Examples.cmake to this directory.
- 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,
- add "-VV" to the ctest command. The output should show;
- 100% tests passed, 0 tests failed out of 156.
+ Copy HDF5Examples-0.1.1-Source folder to this directory.
+ Copy HDF518_Examples.cmake to this directory.
+ Edit line 8 of the HDF518_Examples.cmake file and change the INSTALLDIR
+ to the HDF5 install location.
+
+ Execute from this directory:
+ ctest -S HDF518_Examples.cmake,HDF5Examples-0.1.1-Source -C Release -O test.log
+
+The script will use the examples folder HDF5Examples-0.1.1-Source,
+ and create a build directory inside the HDF5Examples-0.1.1-Source directory.
+ It will then configure, build, and execute the examples. All the log files
+ will be found under the build\Testing\Temporary directory, check these for
+ errors.
+
+The amount of script information can be increased by adding -V to the ctest
+ command. Even more information can be shown by adding -VV instead of -V.
========================================================================
-III. Other changes to the HDF518_Examples.cmake file
+III. Common changes to the HDF518_Examples.cmake file
========================================================================
-Line 10: uncomment to build and test Fortran examples.
+Line 8: change the INSTALLDIR to a different HDF5 install location.
+
+Line 14: uncomment to allow Mac machines to build shared examples.
+
+Line 15: uncomment to build and test Fortran examples.
+
+Line 16: comment to NOT build and test Fortran examples with F2003 option.
-Line 43-45: uncomment to use a source tarball or zipfile;
- Add script option "TAR_SOURCE=MySource.tar".
+Line 17: uncomment to use a compressed source file.