summaryrefslogtreecommitdiffstats
path: root/Source/cmTryCompileCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2011-01-12 13:13:15 (GMT)
committerBrad King <brad.king@kitware.com>2011-01-12 13:13:15 (GMT)
commit4da2a5687be6ec91f8001ba0366776f775531431 (patch)
treeba115312c1ceea8883cbe47a18f6d3471181c368 /Source/cmTryCompileCommand.h
parent90e9b65f10f7e96284d2c75907326faef64c669a (diff)
downloadCMake-4da2a5687be6ec91f8001ba0366776f775531431.zip
CMake-4da2a5687be6ec91f8001ba0366776f775531431.tar.gz
CMake-4da2a5687be6ec91f8001ba0366776f775531431.tar.bz2
Document try_compile behavior more clearly (#11688)
Explicitly state up front that the source-file form of the command links an executable and expects a 'main' to be defined. While at it, update the command signature documentation to use a syntax more consistent with other commands. Also tweak some wording.
Diffstat (limited to 'Source/cmTryCompileCommand.h')
-rw-r--r--Source/cmTryCompileCommand.h41
1 files changed, 23 insertions, 18 deletions
diff --git a/Source/cmTryCompileCommand.h b/Source/cmTryCompileCommand.h
index 3a30e4c..5b4ffca 100644
--- a/Source/cmTryCompileCommand.h
+++ b/Source/cmTryCompileCommand.h
@@ -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 "