summaryrefslogtreecommitdiffstats
path: root/Source/cmTryRunCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-09-17 17:23:40 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-16 13:22:36 (GMT)
commite33d8d2d7799271e94b4f1215c77d6a685f82b88 (patch)
tree03726a7dacd9c06731de417d3f8c82f7bbb5e8f1 /Source/cmTryRunCommand.h
parent399e9c46d88c12507f1a762e69225c5ab9f4ac08 (diff)
downloadCMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.zip
CMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.tar.gz
CMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.tar.bz2
Drop builtin command documentation
Drop all GetTerseDocumentation and GetFullDocumentation methods from commands. The command documentation is now in Help/command/*.rst files.
Diffstat (limited to 'Source/cmTryRunCommand.h')
-rw-r--r--Source/cmTryRunCommand.h57
1 files changed, 0 insertions, 57 deletions
diff --git a/Source/cmTryRunCommand.h b/Source/cmTryRunCommand.h
index 13b9973..d0bf9ce 100644
--- a/Source/cmTryRunCommand.h
+++ b/Source/cmTryRunCommand.h
@@ -42,63 +42,6 @@ public:
*/
virtual const char* GetName() const { return "try_run";}
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return "Try compiling and then running some code.";
- }
-
- /**
- * More documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR\n"
- " bindir srcfile [CMAKE_FLAGS <Flags>]\n"
- " [COMPILE_DEFINITIONS <flags>]\n"
- " [COMPILE_OUTPUT_VARIABLE comp]\n"
- " [RUN_OUTPUT_VARIABLE run]\n"
- " [OUTPUT_VARIABLE var]\n"
- " [ARGS <arg1> <arg2>...])\n"
- "Try compiling a srcfile. Return TRUE or FALSE for success or failure "
- "in COMPILE_RESULT_VAR. Then if the compile succeeded, run the "
- "executable and return its exit code in RUN_RESULT_VAR. "
- "If the executable was built, but failed to run, then RUN_RESULT_VAR "
- "will be set to FAILED_TO_RUN. "
- "COMPILE_OUTPUT_VARIABLE specifies the variable where the output from "
- "the compile step goes. RUN_OUTPUT_VARIABLE specifies the variable "
- "where the output from the running executable goes.\n"
- "For compatibility reasons OUTPUT_VARIABLE is still supported, which "
- "gives you the output from the compile and run step combined.\n"
- "Cross compiling issues\n"
- "When cross compiling, the executable compiled in the first step "
- "usually cannot be run on the build host. try_run() checks the "
- "CMAKE_CROSSCOMPILING variable to detect whether CMake is in "
- "crosscompiling mode. If that's the case, it will still try to compile "
- "the executable, but it will not try to run the executable. Instead it "
- "will create cache variables which must be filled by the user or by "
- "presetting them in some CMake script file to the values the "
- "executable would have produced if it had been run on its actual "
- "target platform. These variables are RUN_RESULT_VAR (explanation see "
- "above) and if RUN_OUTPUT_VARIABLE (or OUTPUT_VARIABLE) was used, an "
- "additional cache variable "
- "RUN_RESULT_VAR__COMPILE_RESULT_VAR__TRYRUN_OUTPUT."
- "This is intended to hold stdout and stderr from the executable.\n"
- "In order to make cross compiling your project easier, use try_run "
- "only if really required. If you use try_run, use RUN_OUTPUT_VARIABLE "
- "(or OUTPUT_VARIABLE) only if really required. Using them will require "
- "that when crosscompiling, the cache variables will have to be set "
- "manually to the output of the executable. You can also \"guard\" the "
- "calls to try_run with if(CMAKE_CROSSCOMPILING) and provide an "
- "easy-to-preset alternative for this case.\n"
- "Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build "
- "configuration."
- ;
- }
-
cmTypeMacro(cmTryRunCommand, cmCoreTryCompile);
private:
void RunExecutable(const std::string& runArgs,