summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorAlan W. Irwin <airwin@users.sourceforge.net>2014-09-03 14:03:12 (GMT)
committerBrad King <brad.king@kitware.com>2014-09-03 15:19:52 (GMT)
commitabbe91c58ccf49dd60027ec5663154e54365f0fe (patch)
tree4c48a26ce55342ec39e37914334b59177a2a5d04 /Help
parentfb8acb74e83a591c1231c4a07c221f4392f4c0be (diff)
downloadCMake-abbe91c58ccf49dd60027ec5663154e54365f0fe.zip
CMake-abbe91c58ccf49dd60027ec5663154e54365f0fe.tar.gz
CMake-abbe91c58ccf49dd60027ec5663154e54365f0fe.tar.bz2
Help: Clarify --debug-trycompile usage with try_compile
Explain that try_compile calls need to be protected with conditions to avoid running more than once so that it is easy to isolate a single try_compile to perform with --debug-trycompile.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/try_compile.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst
index 8ed3cf4..224c67b 100644
--- a/Help/command/try_compile.rst
+++ b/Help/command/try_compile.rst
@@ -36,9 +36,10 @@ cleaned automatically. For debugging, --debug-trycompile can be
passed to cmake to avoid this clean. However, multiple sequential
try_compile operations reuse this single output directory. If you use
--debug-trycompile, you can only debug one try_compile call at a time.
-The recommended procedure is to configure with cmake all the way
-through once, then delete the cache entry associated with the
-try_compile call of interest, and then re-run cmake again with
+The recommended procedure is to protect all try_compile calls in your
+project by ``if(NOT DEFINED RESULT_VAR)`` logic, configure with cmake
+all the way through once, then delete the cache entry associated with
+the try_compile call of interest, and then re-run cmake again with
--debug-trycompile.
Some extra flags that can be included are, INCLUDE_DIRECTORIES,