summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-07-20 16:39:37 (GMT)
committerKitware Robot <kwrobot@kitware.com>2022-07-20 16:39:44 (GMT)
commit4ea33b41d7814af7ef4c2d5b155d04de5eae4cb5 (patch)
tree3479ee9ccbc438ad0e6bbbbe7566f00f0695db98
parent6ef67d936327c5c7c6b9b7615c90bf0e57a66658 (diff)
parent70c26a65b72c3ade0e6bd79dd0d0802e7e4770f8 (diff)
downloadCMake-4ea33b41d7814af7ef4c2d5b155d04de5eae4cb5.zip
CMake-4ea33b41d7814af7ef4c2d5b155d04de5eae4cb5.tar.gz
CMake-4ea33b41d7814af7ef4c2d5b155d04de5eae4cb5.tar.bz2
Merge topic 'doc-execute_process'
70c26a65b7 Help: Clarify execute_process OS-specific command-line encoding Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7492
-rw-r--r--Help/command/execute_process.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst
index 82fcd46..d4ba465 100644
--- a/Help/command/execute_process.rst
+++ b/Help/command/execute_process.rst
@@ -37,8 +37,15 @@ 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.
+ CMake executes the child process using operating system APIs directly:
+
+ * On POSIX platforms, the command line is passed to the
+ child process in an ``argv[]`` style array.
+
+ * On Windows platforms, the command line is encoded as a string such
+ that child processes using ``CommandLineToArgvW`` will decode the
+ original arguments.
+
No intermediate shell is used, so shell operators such as ``>``
are treated as normal arguments.
(Use the ``INPUT_*``, ``OUTPUT_*``, and ``ERROR_*`` options to