From 0e986b12fc1af2fdc3f88fd55d280ca5ded2940c Mon Sep 17 00:00:00 2001 From: Bill Hoffman Date: Tue, 19 Jul 2005 15:27:12 -0400 Subject: [PATCH] ENH: add more docs --- Source/cmTryCompileCommand.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/Source/cmTryCompileCommand.h b/Source/cmTryCompileCommand.h index f2353d82b..b857da618 100644 --- a/Source/cmTryCompileCommand.h +++ b/Source/cmTryCompileCommand.h @@ -85,11 +85,20 @@ public: " ...>\n" " )\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( " + " INCLUDE_DIRECTORIES(${INCLUDE_DIRECTORIES})" + " LINK_DIRECTORIES(${LINK_DIRECTORIES})" + " ADD_EXECUTABLE(cmTryCompileExec sources)" + " TARGET_LINK_LIBRARIES(cmTryCompileExec ${LINK_LIBRARIES})"; } cmTypeMacro(cmTryCompileCommand, cmCommand);