summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAllen Byrne <byrn@hdfgroup.org>2013-09-19 13:22:59 (GMT)
committerAllen Byrne <byrn@hdfgroup.org>2013-09-19 13:22:59 (GMT)
commitba21e5b5e3202bbb669933884e9c014a6c3cd11e (patch)
treebb54bbda0298b6a4c29f5421dbf9c70074d83825
parentcbe069269b7a6e02aaca103d54471034a07cc247 (diff)
downloadhdf5-ba21e5b5e3202bbb669933884e9c014a6c3cd11e.zip
hdf5-ba21e5b5e3202bbb669933884e9c014a6c3cd11e.tar.gz
hdf5-ba21e5b5e3202bbb669933884e9c014a6c3cd11e.tar.bz2
[svn-r24164] Add documentation on usage.
-rw-r--r--UserMacros.cmake5
-rw-r--r--config/cmake/UserMacros/Windows_MT.cmake2
-rw-r--r--release_docs/INSTALL_CMake.txt18
3 files changed, 23 insertions, 2 deletions
diff --git a/UserMacros.cmake b/UserMacros.cmake
index d7d3ef9..4c680ed 100644
--- a/UserMacros.cmake
+++ b/UserMacros.cmake
@@ -3,6 +3,8 @@
########################################################
#-----------------------------------------------------------------------------
+#------------------- E X A M P L E B E G I N--------------------------------
+#-----------------------------------------------------------------------------
# Option to Build with User Defined Values
#-----------------------------------------------------------------------------
MACRO (MACRO_USER_DEFINED_LIBS)
@@ -14,4 +16,7 @@ OPTION (BUILD_USER_DEFINED_LIBS "Build With User Defined Values" OFF)
IF (BUILD_USER_DEFINED_LIBS)
MACRO_USER_DEFINED_LIBS ()
ENDIF (BUILD_USER_DEFINED_LIBS)
+#-----------------------------------------------------------------------------
+#------------------- E X A M P L E E N D -----------------------------------
+#-----------------------------------------------------------------------------
\ No newline at end of file
diff --git a/config/cmake/UserMacros/Windows_MT.cmake b/config/cmake/UserMacros/Windows_MT.cmake
index 9be5404..175c420 100644
--- a/config/cmake/UserMacros/Windows_MT.cmake
+++ b/config/cmake/UserMacros/Windows_MT.cmake
@@ -4,6 +4,8 @@
# To use this option, copy both the macro and option code
# into the root UserMacros.cmake file.
+# OR add an include to the root UserMacros.cmake file:
+# INCLUDE(path_to_file/WINDOWS_MT.cmake)
#-----------------------------------------------------------------------------
# Option to Build with Static CRT libraries on Windows
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index 5594610..3dc52d7 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -8,7 +8,8 @@ Section I: Quick Step Building HDF5 Libraries with CMake
Section II: Preconditions
Section III: Building HDF5 C/C++ Libraries with CMake
Section IV: All Options for HDF5 C/C++ Libraries with CMake
-Section V: APPENDIX
+Section V: User Defined Options for HDF5 Libraries with CMake
+Section VI: APPENDIX
************************************************************************
@@ -449,7 +450,20 @@ IF (HDF5_ENABLE_SZIP_SUPPORT)
========================================================================
-V. APPENDIX
+V. User Defined Options for HDF5 Libraries with CMake
+========================================================================
+
+Support for User Defined macros and options has been added. The file
+UserMacros.cmake has an example of the technique. In the folder,
+config/cmake/UserMacros, is an implementation for Windows Visual Studio
+users for linking libraries to the static CRT - Windows_MT.cmake.
+
+Copy the contents of the file, both macro and option, into the
+UserMacros.cmake file. Then enable the option to the CMake configuration,
+build and test process.
+
+========================================================================
+VI. APPENDIX
========================================================================
Below are examples of the ctest scripts used by The HDF Group.