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

Merge topic 'doc-try_compile-clarification' 

cabb6cd Document Check(C|CXX)SourceCompiles behavior more clearly (#11688)
4da2a56 Document try_compile behavior more clearly (#11688)
This commit is contained in:
Brad King 2011-01-19 14:02:11 -05:00 committed by CMake Topic Stage
parent 9ae65b866e cabb6cd00e
commit 27039e62f9
3 changed files with 27 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Modules/CheckCSourceCompiles.cmake
View File

@ -1,6 +1,6 @@
# - Check if the given C source code compiles.
# - Check if given C source compiles and links into an executable
# CHECK_C_SOURCE_COMPILES(<code> <var> [FAIL_REGEX <fail-regex>])
# <code> - source code to try to compile
# <code> - source code to try to compile, must define 'main'
# <var> - variable to store whether the source code compiled
# <fail-regex> - fail if test output matches this regex
# The following variables may be set before calling this macro to

4
Modules/CheckCXXSourceCompiles.cmake
View File

@ -1,6 +1,6 @@
# - Check if the given C++ source code compiles.
# - Check if given C++ source compiles and links into an executable
# CHECK_CXX_SOURCE_COMPILES(<code> <var> [FAIL_REGEX <fail-regex>])
# <code> - source code to try to compile
# <code> - source code to try to compile, must define 'main'
# <var> - variable to store whether the source code compiled
# <fail-regex> - fail if test output matches this regex
# The following variables may be set before calling this macro to

41
Source/cmTryCompileCommand.h
View File

@ -47,7 +47,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
return "Try compiling some code.";
return "Try building some code.";
}
/**
@ -55,23 +55,28 @@ public:
virtual const char* GetFullDocumentation()
{
return
" try_compile(RESULT_VAR bindir srcdir\n"
" projectName <targetname> [CMAKE_FLAGS <Flags>]\n"
" [OUTPUT_VARIABLE var])\n"
"Try compiling a program. In this form, srcdir should contain a "
"complete CMake project with a CMakeLists.txt file and all sources. The "
"bindir and srcdir will not be deleted after this command is run. "
"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"
" [COPY_FILE <filename> )\n"
"Try compiling a srcfile. In this case, the user need only supply a "
"source file. CMake will create the appropriate CMakeLists.txt file "
"to build the source. If COPY_FILE is used, the compiled file will be "
"copied to the given file.\n"
" try_compile(RESULT_VAR <bindir> <srcdir>\n"
" <projectName> [targetName] [CMAKE_FLAGS flags...]\n"
" [OUTPUT_VARIABLE <var>])\n"
"Try building a project. In this form, srcdir should contain a "
"complete CMake project with a CMakeLists.txt file and all sources. "
"The bindir and srcdir will not be deleted after this command is run. "
"Specify targetName to build a specific target instead of the 'all' or "
"'ALL_BUILD' target."
"\n"
" try_compile(RESULT_VAR <bindir> <srcfile>\n"
" [CMAKE_FLAGS flags...]\n"
" [COMPILE_DEFINITIONS flags...]\n"
" [OUTPUT_VARIABLE <var>]\n"
" [COPY_FILE <fileName>])\n"
"Try building a source file into an executable. "
"In this form the user need only supply a source file that defines "
"a 'main'. "
"CMake will create a CMakeLists.txt file to build the source "
"as an executable. "
"Specify COPY_FILE to get a copy of the linked executable at the "
"given fileName."
"\n"
"In this version all files in bindir/CMakeFiles/CMakeTmp, "
"will be cleaned automatically, for debugging a --debug-trycompile can "
"be passed to cmake to avoid the clean. Some extra flags that "