summaryrefslogtreecommitdiffstats
path: root/Source/cmTryCompileCommand.h
diff options
context:
space:
mode:
authorBill Hoffman <bill.hoffman@kitware.com>2005-07-19 19:27:12 (GMT)
committerBill Hoffman <bill.hoffman@kitware.com>2005-07-19 19:27:12 (GMT)
commit0e986b12fc1af2fdc3f88fd55d280ca5ded2940c (patch)
treefa9dba8ff5833b2b757ad632cb11fa1eef1ba5c8 /Source/cmTryCompileCommand.h
parentaf4b6fbfed9fd0563226dd229283156149ec537d (diff)
downloadCMake-0e986b12fc1af2fdc3f88fd55d280ca5ded2940c.zip
CMake-0e986b12fc1af2fdc3f88fd55d280ca5ded2940c.tar.gz
CMake-0e986b12fc1af2fdc3f88fd55d280ca5ded2940c.tar.bz2
ENH: add more docs
Diffstat (limited to 'Source/cmTryCompileCommand.h')
-rw-r--r--Source/cmTryCompileCommand.h13
1 files changed, 11 insertions, 2 deletions
diff --git a/Source/cmTryCompileCommand.h b/Source/cmTryCompileCommand.h
index f2353d8..b857da6 100644
--- a/Source/cmTryCompileCommand.h
+++ b/Source/cmTryCompileCommand.h
@@ -85,11 +85,20 @@ public:
" <COMPILE_DEFINITIONS <flags> ...>\n"
" <OUTPUT_VARIABLE var>)\n"
"Try compiling a srcfile. Return the success or failure in RESULT_VAR. "
- "CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags to cmake. The "
+ "CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags to cmake. Some "
+ "extra flags that can be included are , "
+ "INCLUDE_DIRECTORIES, LINK_DIRECTORIES, and LINK_LIBRARIES. "
"COMPILE_DEFINITIONS are -Ddefinition that will be passed to the "
"compile line. If srcfile is specified the files in bindir/CMakeTmp "
"are cleaned automatically. If OUTPUT_VARIABLE is specified, then the "
- "output from the build process is stored in the given variable.";
+ "output from the build process is stored in the given variable. "
+ "TRY_COMPILE creates a CMakeList.txt "
+ "file on the fly, and in that file it looks like this: "
+ " ADD_DEFINITIONS( <expanded COMPILE_DEFINITIONS from calling cmake>"
+ " INCLUDE_DIRECTORIES(${INCLUDE_DIRECTORIES})"
+ " LINK_DIRECTORIES(${LINK_DIRECTORIES})"
+ " ADD_EXECUTABLE(cmTryCompileExec sources)"
+ " TARGET_LINK_LIBRARIES(cmTryCompileExec ${LINK_LIBRARIES})";
}
cmTypeMacro(cmTryCompileCommand, cmCommand);