diff options
| author | Brad King <brad.king@kitware.com> | 2019-03-21 13:46:44 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2019-03-21 13:47:20 (GMT) |
| commit | 1e9cb46c8a9c78261d22ad40af5aff1635b919cf (patch) | |
| tree | b8ca0714d2cccd9267405b550c65e4fd79e4bf16 /Help | |
| parent | 58b83f24c7a3cff8fabc175ea85e24bc0543ba42 (diff) | |
| parent | 0295b153f4ee0506f1b23f5b941cfd28ee7201db (diff) | |
| download | CMake-1e9cb46c8a9c78261d22ad40af5aff1635b919cf.zip CMake-1e9cb46c8a9c78261d22ad40af5aff1635b919cf.tar.gz CMake-1e9cb46c8a9c78261d22ad40af5aff1635b919cf.tar.bz2 | |
Merge topic 'timeout'
0295b153f4 Help: describe the command pipeline of execute_process more explicitly
33efdfc0b5 Help: improve source formatting
cd524c1c33 Help: describe what happens if command execute_process reaches timeout.
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !3129
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/execute_process.rst | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index 3a56dce..2d71352 100644 --- a/Help/command/execute_process.rst +++ b/Help/command/execute_process.rst @@ -22,7 +22,9 @@ Execute one or more child processes. [ERROR_STRIP_TRAILING_WHITESPACE] [ENCODING <name>]) -Runs the given sequence of one or more commands in parallel with the standard +Runs the given sequence of one or more commands. + +Commands are executed concurrently as a pipeline, 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. @@ -46,8 +48,9 @@ Options: the child processes. ``TIMEOUT`` - The child processes will be terminated if they do not finish in the - specified number of seconds (fractions are allowed). + After the specified number of seconds (fractions allowed), all unfinished + child processes will be terminated, and the ``RESULT_VARIABLE`` will be + set to a string mentioning the "timeout". ``RESULT_VARIABLE`` The variable will be set to contain the result of last child process. @@ -56,9 +59,9 @@ Options: ``RESULTS_VARIABLE <variable>`` The variable will be set to contain the result of all processes as a - :ref:`semicolon-separated list <CMake Language Lists>`, in order of the given ``COMMAND`` - arguments. Each entry will be an integer return code from the - corresponding child or a string describing an error condition. + :ref:`semicolon-separated list <CMake Language Lists>`, in order of the + given ``COMMAND`` arguments. Each entry will be an integer return code + from the corresponding child or a string describing an error condition. ``OUTPUT_VARIABLE``, ``ERROR_VARIABLE`` The variable named will be set with the contents of the standard output |