summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-02-14 13:30:27 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2017-02-14 13:30:27 (GMT)
commit31e96ccca23a034700e780470bf48cff0d7fd15e (patch)
treec93d7ae905897e65414f31d02dbde1e1739cf7c5 /Help
parent11e9605179e340833d95115fb0178d2ee84b3e24 (diff)
parent07c3380a6e2a09b7e5976ddbacf385b8b4cde2cd (diff)
downloadCMake-31e96ccca23a034700e780470bf48cff0d7fd15e.zip
CMake-31e96ccca23a034700e780470bf48cff0d7fd15e.tar.gz
CMake-31e96ccca23a034700e780470bf48cff0d7fd15e.tar.bz2
Merge topic 'execute_process-default-encoding'
07c3380a execute_process: Restore no-decoding default behavior 4168bc18 Help: Improve execute_process ENCODING option documentation
Diffstat (limited to 'Help')
-rw-r--r--Help/command/execute_process.rst19
1 files changed, 15 insertions, 4 deletions
diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst
index 71233d9..d617243 100644
--- a/Help/command/execute_process.rst
+++ b/Help/command/execute_process.rst
@@ -70,10 +70,21 @@ Options:
``ENCODING <name>``
On Windows, the encoding that is used to decode output from the process.
Ignored on other platforms.
- Valid encoding names are: ``AUTO`` (the default), ``NONE``, ``UTF8``,
- ``ANSI`` and ``OEM``.
- ``AUTO`` encoding means current active console's codepage will be used
- or if that isn't available then ``ANSI`` codepage will be used.
+ Valid encoding names are:
+
+ ``NONE``
+ Perform no decoding. This assumes that the process output is encoded
+ in the same way as CMake's internal encoding (UTF-8).
+ This is the default.
+ ``AUTO``
+ Use the current active console's codepage or if that isn't
+ available then use ANSI.
+ ``ANSI``
+ Use the ANSI codepage.
+ ``OEM``
+ Use the original equipment manufacturer (OEM) code page.
+ ``UTF8``
+ Use the UTF-8 codepage.
If more than one ``OUTPUT_*`` or ``ERROR_*`` option is given for the
same pipe the precedence is not specified.