kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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
This commit is contained in:
Brad King 2013-11-07 16:40:15 -05:00
parent ea6b656f0c
commit 3bb6266492
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Help/command/execute_process.rst
View File

@ -26,6 +26,16 @@ A single standard error pipe is used for all processes.
Options: 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 WORKING_DIRECTORY
The named directory will be set as the current working directory of The named directory will be set as the current working directory of
the child processes. 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 The :command:`execute_process` command is a newer more powerful version of
:command:`exec_program`, but the old command has been kept for compatibility. :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.