kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

STYLE: fix docs

This commit is contained in:
Ken Martin 2005-11-17 11:39:02 -05:00
parent f6ef36d8b2
commit 4d2ce04caa
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Source/cmTryCompileCommand.h
View File

@ -77,28 +77,28 @@ public:
" TRY_COMPILE(RESULT_VAR bindir srcdir\n"
" projectName <targetname> <CMAKE_FLAGS <Flags>>\n"
" <OUTPUT_VARIABLE var>)\n"
"Try compiling a program. Return the success or failure in RESULT_VAR. "
"Try compiling a program. Return the success or failure in RESULT_VAR. "
"If <target name> is specified then build just that target "
"otherwise the all or ALL_BUILD target is built.\n"
" TRY_COMPILE(RESULT_VAR bindir srcfile\n"
" <CMAKE_FLAGS <Flags>>\n"
" <COMPILE_DEFINITIONS <flags> ...>\n"
" <OUTPUT_VARIABLE var>)\n"
"Try compiling a srcfile. Return the success or failure in RESULT_VAR. "
"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. Some "
"extra flags that can be included are , "
"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. "
"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})";
"file on the fly, and in that file it looks like this:\n"
" ADD_DEFINITIONS( <expanded COMPILE_DEFINITIONS from calling cmake>)\n"
" INCLUDE_DIRECTORIES(${INCLUDE_DIRECTORIES})\n"
" LINK_DIRECTORIES(${LINK_DIRECTORIES})\n"
" ADD_EXECUTABLE(cmTryCompileExec sources)\n"
" TARGET_LINK_LIBRARIES(cmTryCompileExec ${LINK_LIBRARIES})\n";
}
cmTypeMacro(cmTryCompileCommand, cmCommand);

2
Source/cmTryRunCommand.h
View File

@ -66,7 +66,7 @@ public:
" <ARGUMENTS <arg1> <arg2>...>)\n"
"Try compiling a srcfile. Return the success or failure in "
"COMPILE_RESULT_VAR. Then if the compile succeeded, run the "
"executable and return the result in RUN_RESULT_VAR."
"executable and return the result in RUN_RESULT_VAR. "
"If the executable was built, but failed for to run for some "
"reason, then RUN_RESULT_VAR will be set to FAILED_TO_RUN, and "
"the output will be in the COMPILE_RESULT_VAR.";