summaryrefslogtreecommitdiffstats
path: root/Source/cmExecuteProcessCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-10-16 13:28:12 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2013-10-16 13:28:12 (GMT)
commitc49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740 (patch)
tree96102c69673467ce7b922697cd5f378511249201 /Source/cmExecuteProcessCommand.h
parent5029da5eac08171653a92b961c341f7ffcca3640 (diff)
parent7038a93a7eafa83d506dd73bed171dc72dfbd9a5 (diff)
downloadCMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.zip
CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.gz
CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.bz2
Merge topic 'doc-reStructuredText'
7038a93 Modules/readme.txt: Update steps to add module documentation a77e308 CPack: Replace #<type> markup with reStructuredText equivalent e7ca48f Help: Factor out cmake-generator-expressions manual page 97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication 8982161 Help: Factor out find_* command duplication 30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication bfe07aa Build Help documentation during CMake build using Sphinx 53ded59 Drop unused builtin documentation APIs 0c39a75 Drop the 'Full' field from cmDocumentationEntry e33d8d2 Drop builtin command documentation 399e9c4 Drop builtin property documentation 6035c04 get_property: Drop test for builtin property documentation 80a3273 Drop all documentation formatters except Usage b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents ec6df36 Teach --help-* options to load documentation from .rst files 25f2877 Add class cmRST to do basic reStructuredText processing ...
Diffstat (limited to 'Source/cmExecuteProcessCommand.h')
-rw-r--r--Source/cmExecuteProcessCommand.h58
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);
};