From cd524c1c333fdba71d684bf2759ebb583ad0b021 Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (l)" Date: Wed, 20 Mar 2019 18:17:29 +0100 Subject: Help: describe what happens if command execute_process reaches timeout. --- Help/command/execute_process.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index 3a56dce..bbcb37a 100644 --- a/Help/command/execute_process.rst +++ b/Help/command/execute_process.rst @@ -46,8 +46,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. -- cgit v0.12 From 33efdfc0b541d8ccb9d4a5b06598c2964a7285ba Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (l)" Date: Wed, 20 Mar 2019 18:19:10 +0100 Subject: Help: improve source formatting --- Help/command/execute_process.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index bbcb37a..9209f95 100644 --- a/Help/command/execute_process.rst +++ b/Help/command/execute_process.rst @@ -57,9 +57,9 @@ Options: ``RESULTS_VARIABLE `` The variable will be set to contain the result of all processes as a - :ref:`semicolon-separated list `, 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 `, 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 -- cgit v0.12 From 0295b153f4ee0506f1b23f5b941cfd28ee7201db Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (l)" Date: Wed, 20 Mar 2019 18:25:52 +0100 Subject: Help: describe the command pipeline of execute_process more explicitly When reading the doc page on execute_process, I was mislead by the words "in parallel". They convinced at once that the processes are run independently of each other, so that I did not even bother to read further. The rewording, and not least the insertion of a paragraph break, should prevent such oversight. --- Help/command/execute_process.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index 9209f95..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 ]) -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. -- cgit v0.12