summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-11-07 21:40:15 (GMT)
committerBrad King <brad.king@kitware.com>2013-11-07 21:42:39 (GMT)
commit3bb62664924ce2937d30f828d84775d13ef6cae5 (patch)
tree4a30fc7bf38e1e629b33b3a04cc3e8c5d12bce03 /Help/command
parentea6b656f0ced8d0cb401f9de515d5e7358130aa5 (diff)
downloadCMake-3bb62664924ce2937d30f828d84775d13ef6cae5.zip
CMake-3bb62664924ce2937d30f828d84775d13ef6cae5.tar.gz
CMake-3bb62664924ce2937d30f828d84775d13ef6cae5.tar.bz2
Help: Clarify execute_process COMMAND argument behavior
State in the execute_process how COMMAND arguments are passed to the child. Add a note at the end about how the command differs from add_custom_*(). Suggested-by: Alan W. Irwin
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/execute_process.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst
index af69f3f..478b30e 100644
--- a/Help/command/execute_process.rst
+++ b/Help/command/execute_process.rst
@@ -26,6 +26,16 @@ A single standard error pipe is used for all processes.
Options:
+COMMAND
+ A child process command line.
+
+ CMake executes the child process using operating system APIs directly.
+ All arguments are passed VERBATIM to the child process.
+ No intermediate shell is used, so shell operators such as ``>``
+ are treated as normal arguments.
+ (Use the ``INPUT_*``, ``OUTPUT_*``, and ``ERROR_*`` options to
+ redirect stdin, stdout, and stderr.)
+
WORKING_DIRECTORY
The named directory will be set as the current working directory of
the child processes.
@@ -59,3 +69,7 @@ be shared with the corresponding pipes of the CMake process itself.
The :command:`execute_process` command is a newer more powerful version of
:command:`exec_program`, but the old command has been kept for compatibility.
+Both commands run while CMake is processing the project prior to build
+system generation. Use :command:`add_custom_target` and
+:command:`add_custom_command` to create custom commands that run at
+build time.