summaryrefslogtreecommitdiffstats
path: root/release_docs/INSTALL_CMake.txt
diff options
context:
space:
mode:
authorAllen Byrne <byrn@hdfgroup.org>2018-08-16 20:45:17 (GMT)
committerAllen Byrne <byrn@hdfgroup.org>2018-08-16 20:45:31 (GMT)
commit454b04176ae8daeadcd26bb532ed77c4c051a9c3 (patch)
tree237d4f8f05d0e6f48b09f88d6bb5741dfe0fd150 /release_docs/INSTALL_CMake.txt
parent7d7929d43fdb97b0cf44044eb4ab7211e955b794 (diff)
downloadhdf5-454b04176ae8daeadcd26bb532ed77c4c051a9c3.zip
hdf5-454b04176ae8daeadcd26bb532ed77c4c051a9c3.tar.gz
hdf5-454b04176ae8daeadcd26bb532ed77c4c051a9c3.tar.bz2
Update cmake warnings to match the autotools files better
Diffstat (limited to 'release_docs/INSTALL_CMake.txt')
-rw-r--r--release_docs/INSTALL_CMake.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index 708e713..728fd05 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -12,6 +12,7 @@ Section IV: Further considerations
Section V: Options for building HDF5 Libraries with CMake command line
Section VI: CMake option defaults for HDF5
Section VII: User Defined Options for HDF5 Libraries with CMake
+Section VIII: User Defined Compile Flags for HDF5 Libraries with CMake
************************************************************************
@@ -663,6 +664,30 @@ 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.
+
+========================================================================
+VIII. User Defined Compile Flags for HDF5 Libraries with CMake
+========================================================================
+
+Custom compiler flags can be added by defining the CMAKE_C_FLAGS and
+CMAKE_CXX_FLAGS variables.
+Using a cmake script:
+ set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O2")
+Defined on the configure line:
+ cmake -G "Visual Studio 12 2013" -DCMAKE_C_FLAGS:STRING=-O2 ..
+
+Debug symbols are enabled with configuration selections Debug or RelWithDebInfo.
+The difference between Debug and RelWithDebInfo configurations is that
+RelWithDebInfo optimizes the code similar to Release. It produces fully optimized
+code, but also creates the symbol table and the debug metadata to give the
+debugger input to map the execution back to the original code.
+RelwithDebInfo configuration should not affect the performance when the code
+is run without a debugger attached.
+
+The HDF5_ENABLE_COVERAGE option will add "-g -O0 -fprofile-arcs -ftest-coverage"
+to CMAKE_C_FLAGS.
+
+
========================================================================
For further assistance, send email to help@hdfgroup.org
========================================================================