diff options
author | Brad King <brad.king@kitware.com> | 2013-09-17 17:23:40 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-16 13:22:36 (GMT) |
commit | e33d8d2d7799271e94b4f1215c77d6a685f82b88 (patch) | |
tree | 03726a7dacd9c06731de417d3f8c82f7bbb5e8f1 /Source/cmExecuteProcessCommand.h | |
parent | 399e9c46d88c12507f1a762e69225c5ab9f4ac08 (diff) | |
download | CMake-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/cmExecuteProcessCommand.h')
-rw-r--r-- | Source/cmExecuteProcessCommand.h | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/Source/cmExecuteProcessCommand.h b/Source/cmExecuteProcessCommand.h index 0e20a4b..bd0f783 100644 --- a/Source/cmExecuteProcessCommand.h +++ b/Source/cmExecuteProcessCommand.h @@ -49,64 +49,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Execute one or more child processes."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " execute_process(COMMAND <cmd1> [args1...]]\n" - " [COMMAND <cmd2> [args2...] [...]]\n" - " [WORKING_DIRECTORY <directory>]\n" - " [TIMEOUT <seconds>]\n" - " [RESULT_VARIABLE <variable>]\n" - " [OUTPUT_VARIABLE <variable>]\n" - " [ERROR_VARIABLE <variable>]\n" - " [INPUT_FILE <file>]\n" - " [OUTPUT_FILE <file>]\n" - " [ERROR_FILE <file>]\n" - " [OUTPUT_QUIET]\n" - " [ERROR_QUIET]\n" - " [OUTPUT_STRIP_TRAILING_WHITESPACE]\n" - " [ERROR_STRIP_TRAILING_WHITESPACE])\n" - "Runs the given sequence of one or more commands with the standard " - "output of each process piped to the standard input of the next. " - "A single standard error pipe is used for all processes. " - "If WORKING_DIRECTORY is given the named directory will be set as " - "the current working directory of the child processes. " - "If TIMEOUT is given the child processes will be terminated if they " - "do not finish in the specified number of seconds " - "(fractions are allowed). " - "If RESULT_VARIABLE is given the variable will be set to contain " - "the result of running the processes. This will be an integer return " - "code from the last child or a string describing an error condition. " - "If OUTPUT_VARIABLE or ERROR_VARIABLE are given the variable named " - "will be set with the contents of the standard output and standard " - "error pipes respectively. If the same variable is named for both " - "pipes their output will be merged in the order produced. " - "If INPUT_FILE, OUTPUT_FILE, or ERROR_FILE is given the file named " - "will be attached to the standard input of the first process, " - "standard output of the last process, or standard error of all " - "processes respectively. " - "If OUTPUT_QUIET or ERROR_QUIET is given then the standard output " - "or standard error results will be quietly ignored. " - "If more than one OUTPUT_* or ERROR_* option is given for the same " - "pipe the precedence is not specified. " - "If no OUTPUT_* or ERROR_* options are given the output will be shared " - "with the corresponding pipes of the CMake process itself.\n" - "The execute_process command is a newer more powerful version of " - "exec_program, but the old command has been kept for compatibility." - ; - } - cmTypeMacro(cmExecuteProcessCommand, cmCommand); }; |